Skip to content

Latest commit

 

History

History
98 lines (81 loc) · 3.79 KB

contributing.md

File metadata and controls

98 lines (81 loc) · 3.79 KB
Raw

Contributing

Before proposing a pull request, please check the following:

  • Your code should follow the PSR-2 coding standard. Use php-cs-fixer to fix inconsistencies.
  • If you commit a new feature, be prepared to help maintaining it. Watch the project on GitHub, and please comment on issues or PRs regarding the feature you contributed.
  • You should test your feature well.
  • You should run php build and check the PHAR file works before submitting your pull request. You may need to change phar.readonly php.ini setting to 0 or run the command as php -d phar.readonly=0 build.

Once your code is merged, it is available for free to everybody under the MIT License. Publishing your pull request on the PHPloy GitHub repository means that you agree with this license for your contribution.

Thank you for your contribution! PHPloy wouldn't be so great without you.

Dependencies

To preserve compatibility with PHP 5.5 when you add new dependencies, you should try to update your composer.lock file with the --prefer-lowest option.

composer update --prefer-lowest

The downside is that you to have to set nearly exact versions for your dependencies.

Testing

Special thanks to @mbrugger for implementing the testing functionality, a long awaited feature.

The integration tests provide a docker configuration for a SFTP and FTP server you can use to test the synchronization. A folder in /tmp is mounted into the docker container which can be used to compare the result after running PHPloy.

Executing tests

To get started with testing, please follow the steps below:

  1. Install docker
  2. Start the test server
vagrant@vagrant-ubuntu-trusty-64:/vagrant/PHPloy$ ./tests/start_test_server.sh
  1. run the tests
vagrant@vagrant-ubuntu-trusty-64:/vagrant/PHPloy$ vendor/bin/phpunit tests
PHPUnit 4.8.26 by Sebastian Bergmann and contributors.
...
Time: 2.32 seconds, Memory: 4.25MB
OK (3 tests, 4 assertions)
vagrant@vagrant-ubuntu-trusty-64:/vagrant/PHPloy$
  1. Stop the sftp server
vagrant@vagrant-ubuntu-trusty-64:/vagrant/PHPloy$ ./tests/stop_test_server.sh

Writing new tests

Basically each test should be structured in the following way

  1. Prepare a test repository and phploy.ini configuration
  2. Run PHPLoy
  3. Verify the result of the execution by comparing the source folder with the synchronization result
public function testSyncAddedFileShouldSucceed($testHelper)
{
  $this->testHelper = new PHPLoyTestHelper($testHelper);
  $this->testHelper->givenRepositoryWithConfiguration();
  $this->whenFileIsAdded();
  $this->thenRepositoryIsSynchronizedSuccessfully();
}

Parametrized testing SFTP and FTP

For testing FTP and SFTP at the same time tests can be parametrized. Take a look at the CommitFileTest.php:

class CommitFileTest extends PHPUnit_Framework_TestCase
{
  public function provider()
  {
    return array(
      array('ftp'),
      array('sftp')
    );
  }

  protected $testHelper;
  /**
  * @dataProvider provider
  */
  public function testSyncAddedFileShouldSucceed($testType)
  {
    $this->testHelper = new PHPLoyTestHelper($testHelper);
    // implement the test here
  }
}

The PHPLoyTestHelper is parametrized to provide different configurations based on the type passed to the test method by the PHPunit framework. This is especially helpful if you want to test shared functionality available for multiple protocols.

Travis CI

A .travis.yml file is present on the repositoriy. You can configure your Github account and forked branch to run this file using the travis-ci.org platform.