Skip to content

Latest commit

 

History

History
113 lines (81 loc) · 3.93 KB

CONTRIBUTING.md

File metadata and controls

113 lines (81 loc) · 3.93 KB
Raw

Contributing Guidelines

Please follow common guidelines for our projects here.

Reporting Bugs

  • List of known issues and in case you need to create a new issue, you can do so here.
  • Getting a version of packit:
    rpm -q packit or pip3 freeze | grep packitos

Documentation

If you want to update documentation, create a PR against packit.dev.

Running

To run the packit tool on your local Linux system, with your own modifications, use the following command:

$ pip3 install --user --editable .

Testing

Tests are stored in the tests directory:

  • tests/unit
    • testing small units/parts of the code
    • strictly offline
  • tests/integration
    • testing bigger parts of codebase (integration between multiple units, packit python API)
    • mocking with flexmock instead of using requre
  • tests/functional
    • testing packit as a CLI
    • be careful what you run -- no requre, no mocking
  • tests_recording
    • testing bigger parts of codebase (integration between multiple units, packit python API)
    • use requre for remote communication => offline in the CI
    • prefer requre instead of mocking

Running tests:

We recommend running tests in a container. You need to have podman or docker installed for this.

To build the test image run:

make build-test-image

You can run the test now with:

make check-in-container

To select a subset of the whole test suite, set TEST_TARGET. For example to run only the unit tests use:

TEST_TARGET=tests/unit make check-in-container
(or TEST_TARGET=tests/unit make check)

Tests use pre-generated responses stored in tests_recording/test_data/. To (re-)generate response file(s):

See also tests_recording/README.md

The saving of the responses is turned on by the RECORD_REQUESTS environment variable. The file, that will be used for storing, can be set by RESPONSE_FILE variable or by setting the storage_file property of the persistent storage singleton. This is the code used for base test class in the setUp:

response_file = self.get_datafile_filename() # name generated from the test name
PersistentObjectStorage().storage_file = response_file

As a CI we use Zuul with a configuration in .zuul.yaml. If you want to re-run CI/tests in a pull request, just include recheck in a PR comment.

make check is also available to run the tests in the environment of your choice, but first you'll need to make sure to install all the package and test dependencies, starting with python3-pytest, python3-requre, and python3-flexmock. For now it is up to the reader to figure out how to do this on their system.

Additional configuration for development purposes

Copr build

For cases you'd like to trigger copr build in your copr project, you can configure it in packit configuration of your chosen package:

jobs:
  - job: copr_build
    trigger: pull_request
    metadata:
      targets:
        - some_targets
      # (Optional) Defaults to 'packit'
      owner: <your_fedora_username>
      # (Optional) Defaults to <github_namespace>-<github_repo>
      project: some_project_name

Thank you for your interest! Packit team.