Skip to content

Latest commit

 

History

History
123 lines (65 loc) · 5.26 KB

contributing.rst

File metadata and controls

123 lines (65 loc) · 5.26 KB

Contributing

catalystcentersdk is a community development project. Feedback, thoughts, ideas, and code contributions are most welcome!

How to contribute Feedback, Issues, Thoughts and Ideas

Please use the issues page to report issues or post ideas for enhancement.

Interested in Contributing Code?

Developer Scripts

We have created some scripts to automate everyday actions needed when working on the project. Please see the script directory, and it's README for more information.

Notes on the Test Suite

The test suite is grouped by CatalystCenter versions supported in the Cisco CatalystCenter SDK.

The test suite uses a mockup server, instead of calling to a CatalystCenter server directly.

The mockup server is not perfect, that is why it is sometimes necessary to rerun a failed test, we do this by using pytest-rerunfailures. On the script/test file, you can find the pytest-rerunfailures settings, adjust them locally if strictly necessary.

Contributing Code - Using the CI Automated Testing

  1. Check for open issues or create a new issue for the item you want to work on and make sure to comment and let us know that you are working on it.

  2. Fork a copy of the repository and clone your forked repository to your development environment.

  3. Run script/setup to install the development dependencies and setup your environment.

  4. Configure the following environment variables in your development environment:

    • TEST_CATALYST_CENTER_ENCODED_AUTH - Your test account's CatalystCenter encoded_auth (username:password encoded in base 64). This variable has priority over username and password.
    • TEST_CATALYST_CENTER_USERNAME - Your test account's CatalystCenter username.
    • TEST_CATALYST_CENTER_PASSWORD - Your test account's CatalystCenter password.
    • DEBUG_ENVIRONMENT_VARIABLE - Your test's debug variable, which controls whether to log information about CatalystCenter APIs' request and response process.
    • VERSION_ENVIRONMENT_VARIABLE - The CatalystCenter API's version used to test the SDK.

  5. Add your code to your forked repository.

    If you are creating some new feature or functionality (excellent!), please also write a test to verify that your code works as expected.

  6. We follow PEP8 reasonably strictly for this project. Please make sure your code passes the linter.

    Run script/test lint or simply run flake8 from the project root.

  7. Commit your changes.

  8. Submit a pull request. The GitHub/Travis CI system runs the test suite against your pull request code. If any tests fail, please review your changes. If everything looks good, we will gladly merge your request!

Contributing Code - Running the Test Suite Locally

  1. Check for open issues or create a new 'issue' for the item you want to work on and make sure to comment and let us know that you are working on it.

  2. Fork a copy of the repository and clone your forked repository to your development environment.

    Run script/setup to install the development dependencies and setup your environment.

  3. Configure the following environment variables in your development environment:

    • TEST_CATALYST_CENTER_ENCODED_AUTH - Your test account's CatalystCenter encoded_auth (username:password encoded in base 64). This variable has priority over username and password.
    • TEST_CATALYST_CENTER_USERNAME - Your test account's CatalystCenter username.
    • TEST_CATALYST_CENTER_PASSWORD - Your test account's CatalystCenter password.
    • DEBUG_ENVIRONMENT_VARIABLE - Your test's debug variable, which controls whether to log information about CatalystCenter APIs' request and response process.
    • VERSION_ENVIRONMENT_VARIABLE - The CatalystCenter API's version used to test the SDK.

    Example:

    #!/usr/bin/env bash
export TEST_CATALYST_CENTER_ENCODED_AUTH="<test account's username:password encoded in base 64>"

  4. Add your code to your forked repository.

    If you are creating some new feature or functionality (excellent!), please also write a test to verify that your code works as expected.

  5. We follow PEP8 reasonably strictly for this project. Please make sure your code passes the linter.

    Run script/test lint from the project root.

  6. Commit your changes.

  7. Ensure your code passes all of the default tests for all the involved CatalystCenter versions.

    Run script/test and ensure all tests execute successfully.

  8. Submit a pull request. If everything looks good, we will gladly merge your request!