Skip to content

Latest commit

 

History

History
83 lines (62 loc) · 2.28 KB

CONTRIBUTE.md

File metadata and controls

83 lines (62 loc) · 2.28 KB
Raw

Table of Contents

We will be grateful to see you in the ranks of the contributors! We have some issues.

Development

Development takes place on GitHub, where the git-flow branch structure is used:

  • master - contains the latest released code.
  • develop - is used for development of the next release. Pull request must be in this branch
  • feature/XXX - feature branches are used for development of new features before they are merged to develop.

Prepare development environment

pip install -r requirements-dev.txt
pytest -munit

# Install `pre-commit` hooks after clone:
pre-commit install
pre-commit run --all-files

# Run unit tests
tox
# Run integration tests
tox -- -mintegration
# Run Unit and Integration tests
tox -- ""

Tests

We have two type of test.

Unit

If you can write unit tests, please do so. How to run them:

python -mpytest -munit

Integration

We also have some integration test. But you have to prepare your environment a little before you can run these tests.

  1. Get Trial License Key from JFrog
  2. Run Artifactory Pro (only Pro support full REST API) inside docker by command:
docker run --name artifactory-pro -d -p 8081:8081 -p8082:8082 docker.bintray.io/jfrog/artifactory-pro
  1. Open http://localhost:8081 and wait until it'll be ready
  2. Login with admin \ password and complete initialize steps:
    1. Change password to P@ssw0rd. It's important to use exactly this password, we hardcoded it in test.cfg
    2. Install trial license

That all, try to run integration tests!

# Run with current python
python -mpytest -mintegration

# Run through all versions with we do support
tox -- -mintegration

Some useful command with docker:

# Stop artifactory, but save License and user\password
docker stop artifactory-pro

# Start stopped Artifactory. 
docker start artifactory-pro

# Remove installed Artifactory. You'll have to comlete initialize steps again!
docker rm artifactory-pro