File: CONTRIBUTING.md

package info (click to toggle)
python-bugzilla 3.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 1,072 kB
  • sloc: python: 5,760; makefile: 9
file content (65 lines) | stat: -rw-r--r-- 1,954 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# Setting up the environment

If you already have system installed versions of python-bugzilla
dependencies, running the command line from git is as simple as doing:

    cd python-bugzilla.git
    ./bugzilla-cli [arguments]


# Running tests

Our test suite uses pytest. If your system has dependencies already, the
quick unit test suite is invoked simply with:

    pytest

## Read-Only Functional tests

There are more comprehensive, readonly functional tests that run against
several public bugzilla instances, but they are not run by default. No
login account is required. Run them with:

     pytest --ro-functional

## Read/Write Functional Tests.

Read/Write functional tests use partner-bugzilla.redhat.com, which is a
bugzilla instance specifically for this type of testing. Data is occasionally
hard synced with regular bugzilla.redhat.com, and all local edits are
removed. Login accounts are also synced. If you want access to
partner-bugzilla.redhat.com, sign up for a regular bugzilla.redhat.com login
and wait for the next sync period.

Before running these tests, you'll need to cache login credentials.
Example:

    ./bugzilla-cli --bugzilla=partner-bugzilla.redhat.com --username=$USER login
    pytest --rw-functional

## Testing across python versions
To test all supported python versions, run tox using any of the following.

    tox
    tox -- --ro-functional
    tox -- --rw-functional


# pylint and pycodestyle

To test for pylint or pycodestyle violations, you can run:

    ./setup.py pylint

Note: This expects that you already have pylint and pycodestyle installed.


# Patch Submission

If you are submitting a patch, ensure the following:
    [REQ] verify that no new pylint or pycodestyle violations
    [REQ] run basic unit test suite across all python versions as described
        above.

Running any of the functional tests is not a requirement for patch submission,
but please give them a go if you are interested.