├── .flake8
├── .github
├── FUNDING.yml
├── ISSUE_TEMPLATE.md
├── PULL_REQUEST_TEMPLATE.md
└── workflows
│ ├── release.yml
│ └── tests.yml
├── .gitignore
├── .travis.yml
├── CODE-OF-CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── art
├── logo.png
├── logo.svg
└── logo2.svg
├── noxfile.py
├── poetry.lock
├── pyproject.toml
├── pytest_austin
├── __init__.py
├── markers.py
└── plugin.py
└── test
├── conftest.py
└── test_pytest_austin.py
/.flake8:
--------------------------------------------------------------------------------
1 | [flake8]
2 | select = ANN,B,B9,C,D,E,F,W,I
3 | ignore = ANN101,B950,D100,D104,D107,D205,D212,D415,E203,E402,E501,F401,W503,W606
4 | max-line-length = 80
5 | docstring-convention = google
6 | import-order-style = google
7 | per-file-ignores =
8 | test/*:ANN,D
9 | noxfile.py:ANN,D
10 |
--------------------------------------------------------------------------------
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | github: p403n1x87
2 | patreon: P403n1x87
3 | custom: "https://www.buymeacoffee.com/Q9C1Hnm28"
4 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE.md:
--------------------------------------------------------------------------------
1 | ### Description
2 |
3 | [Description of the issue]
4 |
5 | ### Steps to Reproduce
6 |
7 | 1. [First Step]
8 | 2. [Second Step]
9 | 3. [and so on...]
10 |
11 | **Expected behavior:** [What you expect to happen]
12 |
13 | **Actual behavior:** [What actually happens]
14 |
15 | **Reproduces how often:** [What percentage of the time does it reproduce?]
16 |
17 | ### Versions
18 |
19 | Please provide the version of pytest-austin that you are using. Also, please
20 | include the OS and what version of the OS you're running.
21 |
22 | ### Additional Information
23 |
24 | Any additional information, configuration or data that might be necessary to
25 | reproduce the issue.
26 |
--------------------------------------------------------------------------------
/.github/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
1 | ### Requirements for Adding, Changing, Fixing or Removing a Feature
2 |
3 | Fill out the template below. Any pull request that does not include enough
4 | information to be reviewed in a timely manner may be closed at the maintainers'
5 | discretion.
6 |
7 |
8 | ### Description of the Change
9 |
10 |
16 |
17 | ### Alternate Designs
18 |
19 |
21 |
22 | ### Regressions
23 |
24 |
29 |
30 | ### Verification Process
31 |
32 |
42 |
--------------------------------------------------------------------------------
/.github/workflows/release.yml:
--------------------------------------------------------------------------------
1 | name: Release
2 | on:
3 | release:
4 | types: [published]
5 | jobs:
6 | release:
7 | runs-on: ubuntu-latest
8 | steps:
9 | - uses: actions/checkout@v2
10 | - uses: actions/setup-python@v1
11 | with:
12 | python-version: '3.8'
13 | architecture: x64
14 | # - run: pip install nox==2020.5.24
15 | - run: pip install poetry==1.0.5
16 | # - run: nox
17 | - run: poetry build
18 | - run: poetry publish --username=__token__ --password=${{ secrets.PYPI_TOKEN }}
19 |
--------------------------------------------------------------------------------
/.github/workflows/tests.yml:
--------------------------------------------------------------------------------
1 | name: Tests
2 | on: push
3 | jobs:
4 | tests:
5 | runs-on: ${{ matrix.os }}
6 | strategy:
7 | fail-fast: false
8 | matrix:
9 | os: [macos-latest, ubuntu-latest, windows-latest]
10 | name: Tests on ${{ matrix.os }}
11 | steps:
12 | - uses: actions/checkout@v2
13 | with:
14 | path: main
15 |
16 | - uses: actions/setup-python@v2
17 | with:
18 | python-version: '3.x'
19 | architecture: x64
20 |
21 | - name: Checkout Austin development branch
22 | uses: actions/checkout@master
23 | with:
24 | repository: P403n1x87/austin
25 | ref: devel
26 | path: austin
27 |
28 | - name: Compile Austin on Linux
29 | run: |
30 | cd $GITHUB_WORKSPACE/austin
31 | gcc -Wall -O3 -Os -s -pthread src/*.c -o src/austin
32 | sudo setcap cap_sys_ptrace+ep src/austin
33 | if: startsWith(matrix.os, 'ubuntu')
34 |
35 | - name: Compile Austin on Windows
36 | run: |
37 | cd $env:GITHUB_WORKSPACE/austin
38 | gcc.exe -O3 -o src/austin.exe src/*.c -lpsapi -Wall -Os -s
39 | if: startsWith(matrix.os, 'windows')
40 |
41 | - name: Compile Austin on macOS
42 | run: |
43 | cd $GITHUB_WORKSPACE/austin
44 | gcc -Wall -O3 -Os src/*.c -o src/austin
45 | if: startsWith(matrix.os, 'macos')
46 |
47 | - run: pip install nox==2020.5.24
48 | - run: pip install poetry==1.0.5
49 |
50 | - name: Run nox on Linux
51 | run: |
52 | cd $GITHUB_WORKSPACE/main
53 | export PATH="$GITHUB_WORKSPACE/austin/src:$PATH"
54 | nox
55 | if: "startsWith(matrix.os, 'ubuntu')"
56 |
57 | - name: Run nox on macOS
58 | run: |
59 | cd $GITHUB_WORKSPACE/main
60 | export PATH="$GITHUB_WORKSPACE/austin/src:$PATH"
61 | sudo nox
62 | if: startsWith(matrix.os, 'macos')
63 |
64 | - name: Run nox on Windows
65 | run: |
66 | cd $env:GITHUB_WORKSPACE/main
67 | $env:PATH="$env:GITHUB_WORKSPACE/austin/src;$env:PATH"
68 | $env:PYTHONIOENCODING="utf8"
69 | nox
70 | if: "startsWith(matrix.os, 'windows')"
71 |
72 | - name: Publish coverage metrics
73 | run: |
74 | cd $GITHUB_WORKSPACE/main
75 | nox -rs coverage
76 | if: startsWith(matrix.os, 'ubuntu')
77 | env:
78 | CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}
79 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Distribution / packaging
10 | .Python
11 | build/
12 | develop-eggs/
13 | dist/
14 | downloads/
15 | eggs/
16 | .eggs/
17 | lib/
18 | lib64/
19 | parts/
20 | sdist/
21 | var/
22 | wheels/
23 | pip-wheel-metadata/
24 | share/python-wheels/
25 | *.egg-info/
26 | .installed.cfg
27 | *.egg
28 | MANIFEST
29 |
30 | # PyInstaller
31 | # Usually these files are written by a python script from a template
32 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
33 | *.manifest
34 | *.spec
35 |
36 | # Installer logs
37 | pip-log.txt
38 | pip-delete-this-directory.txt
39 |
40 | # Unit test / coverage reports
41 | htmlcov/
42 | .tox/
43 | .nox/
44 | .coverage
45 | .coverage.*
46 | .cache
47 | nosetests.xml
48 | coverage.xml
49 | *.cover
50 | *.py,cover
51 | .hypothesis/
52 | .pytest_cache/
53 |
54 | # Translations
55 | *.mo
56 | *.pot
57 |
58 | # Django stuff:
59 | *.log
60 | local_settings.py
61 | db.sqlite3
62 | db.sqlite3-journal
63 |
64 | # Flask stuff:
65 | instance/
66 | .webassets-cache
67 |
68 | # Scrapy stuff:
69 | .scrapy
70 |
71 | # Sphinx documentation
72 | docs/_build/
73 |
74 | # PyBuilder
75 | target/
76 |
77 | # Jupyter Notebook
78 | .ipynb_checkpoints
79 |
80 | # IPython
81 | profile_default/
82 | ipython_config.py
83 |
84 | # pyenv
85 | .python-version
86 |
87 | # pipenv
88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies
90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not
91 | # install all needed dependencies.
92 | #Pipfile.lock
93 |
94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow
95 | __pypackages__/
96 |
97 | # Celery stuff
98 | celerybeat-schedule
99 | celerybeat.pid
100 |
101 | # SageMath parsed files
102 | *.sage.py
103 |
104 | # Environments
105 | .env
106 | .venv
107 | env/
108 | venv/
109 | ENV/
110 | env.bak/
111 | venv.bak/
112 |
113 | # Spyder project settings
114 | .spyderproject
115 | .spyproject
116 |
117 | # Rope project settings
118 | .ropeproject
119 |
120 | # mkdocs documentation
121 | /site
122 |
123 | # mypy
124 | .mypy_cache/
125 | .dmypy.json
126 | dmypy.json
127 |
128 | # Pyre type checker
129 | .pyre/
130 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: python
2 | os: linux
3 |
4 | git:
5 | depth: 1
6 |
7 | osx_image: xcode10
8 |
9 | dist: bionic
10 |
11 | jobs:
12 | include:
13 | # Linux
14 | - env: TARGET=x86_64-unknown-linux-gnu
15 | os: linux
16 |
17 | before_script:
18 | # Install required Python versions
19 | - sudo add-apt-repository ppa:deadsnakes/ppa -y
20 | - sudo apt-get install python3.{6..9} python3.{6..9}-dev -y;
21 |
22 | # Clone Austin development branch
23 | - git clone --branch devel --depth 1 https://github.com/P403n1x87/austin.git ../austin
24 |
25 | # Compile Austin and grant CAP_SYS_PTRACE capability
26 | - cd ../austin
27 | - gcc -Wall -O3 -Os -s -pthread src/*.c -o src/austin
28 | - sudo setcap cap_sys_ptrace+ep src/austin
29 | - cd -
30 |
31 | - pip install nox==2020.5.24
32 | - pip install poetry==1.0.5
33 |
34 | script:
35 | - export PATH="`realpath ../austin/src`:$PATH"
36 | - nox
37 | - nox -rs coverage
38 |
--------------------------------------------------------------------------------
/CODE-OF-CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | In the interest of fostering an open and welcoming environment, we as
6 | contributors and maintainers pledge to making participation in our project and
7 | our community a harassment-free experience for everyone, regardless of age, body
8 | size, disability, ethnicity, sex characteristics, gender identity and expression,
9 | level of experience, education, socio-economic status, nationality, personal
10 | appearance, race, religion, or sexual identity and orientation.
11 |
12 | ## Our Standards
13 |
14 | Examples of behavior that contributes to creating a positive environment
15 | include:
16 |
17 | * Using welcoming and inclusive language
18 | * Being respectful of differing viewpoints and experiences
19 | * Gracefully accepting constructive criticism
20 | * Focusing on what is best for the community
21 | * Showing empathy towards other community members
22 |
23 | Examples of unacceptable behavior by participants include:
24 |
25 | * The use of sexualized language or imagery and unwelcome sexual attention or
26 | advances
27 | * Trolling, insulting/derogatory comments, and personal or political attacks
28 | * Public or private harassment
29 | * Publishing others' private information, such as a physical or electronic
30 | address, without explicit permission
31 | * Other conduct which could reasonably be considered inappropriate in a
32 | professional setting
33 |
34 | ## Our Responsibilities
35 |
36 | Project maintainers are responsible for clarifying the standards of acceptable
37 | behavior and are expected to take appropriate and fair corrective action in
38 | response to any instances of unacceptable behavior.
39 |
40 | Project maintainers have the right and responsibility to remove, edit, or
41 | reject comments, commits, code, wiki edits, issues, and other contributions
42 | that are not aligned to this Code of Conduct, or to ban temporarily or
43 | permanently any contributor for other behaviors that they deem inappropriate,
44 | threatening, offensive, or harmful.
45 |
46 | ## Scope
47 |
48 | This Code of Conduct applies both within project spaces and in public spaces
49 | when an individual is representing the project or its community. Examples of
50 | representing a project or community include using an official project e-mail
51 | address, posting via an official social media account, or acting as an appointed
52 | representative at an online or offline event. Representation of a project may be
53 | further defined and clarified by project maintainers.
54 |
55 | ## Enforcement
56 |
57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
58 | reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
59 | complaints will be reviewed and investigated and will result in a response that
60 | is deemed necessary and appropriate to the circumstances. The project team is
61 | obligated to maintain confidentiality with regard to the reporter of an incident.
62 | Further details of specific enforcement policies may be posted separately.
63 |
64 | Project maintainers who do not follow or enforce the Code of Conduct in good
65 | faith may face temporary or permanent repercussions as determined by other
66 | members of the project's leadership.
67 |
68 | ## Attribution
69 |
70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72 |
73 | [homepage]: https://www.contributor-covenant.org
74 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing to Austin
2 |
3 | Thanks for taking the time to contribute or considering doing so.
4 |
5 | The following is a set of guidelines for contributing to pytest-austin.
6 |
7 | ## Preamble
8 |
9 | TBD
10 |
11 |
12 | ## The Coding Style
13 |
14 | TBD
15 |
16 |
17 | ## Opening PRs
18 |
19 | Everybody is more than welcome to open a PR to fix a bug/propose enhancements/
20 | implement missing features. If you do, please adhere to the following
21 | styleguides as much as possible.
22 |
23 |
24 | ### Git Commit Messages
25 |
26 | This styleguide is taken from the Atom project.
27 |
28 | * Use the present tense ("Add feature" not "Added feature")
29 | * Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
30 | * Limit the first line to 72 characters or less
31 | * Reference issues and pull requests liberally after the first line
32 |
33 |
34 | ### Labels
35 |
36 | When opening a new PR, please apply a label to them. Try to use existing labels
37 | as much as possible and only create a new one if the current ones are not
38 | applicable.
39 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
58 |
59 | # Synopsis
60 |
61 | The pytest-austin plugin for [pytest](https://docs.pytest.org/en/stable/) brings
62 | Python performance testing right into your CI pipelines. It uses
63 | [Austin](https://github.com/P403n1x87/austin) to profile your test runs without
64 | any instrumentation. All you have to do is simply mark the tests on which you
65 | want to execute checks for preventing performance regressions.
66 |
67 | ~~~ Python
68 | import pytest
69 |
70 |
71 | @pytest.mark.total_time(td(milliseconds=50), function="fibonacci")
72 | @pytest.mark.total_time("99%", line=8)
73 | @pytest.mark.total_time("50.3141592653%", line=9)
74 | def test_hello_default():
75 | fibonacci(27)
76 | fibonacci(25)
77 | ~~~
78 |
79 | Any failed tests will be reported by pytest at the end of the session. All the
80 | collected statistics are written on a file prefixed with `austin_` and followed
81 | by a truncated timestamp, inside pytest rootdir. You can drop it onto
82 | [Speedscope](https://speedscope.app) for a quick visual representation of your
83 | tests.
84 |
85 | ~~~
86 | ================================================================ test session starts ================================================================
87 | platform linux -- Python 3.6.9, pytest-6.0.1, py-1.9.0, pluggy-0.13.1 -- /home/gabriele/.cache/pypoetry/virtualenvs/pytest-austin-yu27Ep_e-py3.6/bin/python3.6
88 | cachedir: .pytest_cache
89 | rootdir: /tmp/pytest-of-gabriele/pytest-226/test_austin_time_checks0
90 | plugins: cov-2.10.0, austin-0.1.0
91 | collecting ... collected 3 items
92 |
93 | test_austin_time_checks.py::test_lines PASSED
94 | test_austin_time_checks.py::test_check_fails PASSED
95 | test_austin_time_checks.py::test_check_succeeds PASSED
96 |
97 | =================================================================== Austin report ===================================================================
98 | austin 2.0.0
99 | Collected stats written on /tmp/pytest-of-gabriele/pytest-226/test_austin_time_checks0/.austin_97148135487643.aprof
100 |
101 | 🕑 Sampling time (min/avg/max) : 376/3327/18019 μs
102 | 🐢 Long sampling rate : 87/87 (100.00 %) samples took longer than the sampling interval
103 | 💀 Error rate : 0/87 (0.00 %) invalid samples
104 |
105 | test_austin_time_checks.py::test_lines test_lines:19 (test_austin_time_checks.py) -16.0 ms (-78.2% of 20.5 ms)
106 | test_austin_time_checks.py::test_lines test_lines:18 (test_austin_time_checks.py) -4.1 ms (-10.1% of 40.3 ms)
107 | test_austin_time_checks.py::test_lines fibonacci (test_austin_time_checks.py) -9.3 ms (-18.6% of 50.0 ms)
108 | test_austin_time_checks.py::test_check_fails test_check_fails (test_austin_time_checks.py) +99.8 ms (9978.6% of 1000.0 μs)
109 | test_austin_time_checks.py::test_check_succeeds test_check_succeeds (test_austin_time_checks.py) -9.0 ms (-8.1% of 110.0 ms)
110 |
111 | ================================================================== 1 check failed ===================================================================
112 |
113 | ================================================================= 3 passed in 0.35s =================================================================
114 | ~~~
115 |
116 |
117 | # Installation
118 |
119 | pytest-austin can be installed directly from PyPI with
120 |
121 | ~~~ bash
122 | pip install pytest-austin --upgrade
123 | ~~~
124 |
125 | **NOTE** In order for the plugin to work, the Austin binary needs to be on the
126 | ``PATH`` environment variable. See [Austin
127 | installation](https://github.com/P403n1x87/austin#installation) instructions to
128 | see how you can easily install Austin on your platform.
129 |
130 | For platform-specific issues and remarks, refer to the
131 | [Compatibility](#compatibility) section below.
132 |
133 |
134 | # Usage
135 |
136 | Once installed, the plugin will try to attach Austin to the pytest process in
137 | order to sample it every time you run pytest. If you want to prevent Austin from
138 | profiling your tests, you have to steal its mojo. You can do so with the
139 | `--steal-mojo` command line argument.
140 |
141 |
142 | ## Time checks
143 |
144 | The plugin looks for the `total_time` marker on collected test items, which
145 | takes a mandatory argument `time` and three optional ones: `function`, `module`
146 | and `line`.
147 |
148 | If you simply want to check that the duration of a test item doesn't take longer
149 | than `time`, you can mark it with `@pytest.mark.total_time(time)`. Here, `time`
150 | can either be a `float` (in seconds) or an instance of `datetime.timedelta`.
151 |
152 | ~~~ python
153 | from datetime import timedelta as td
154 |
155 | import pytest
156 |
157 |
158 | @pytest.mark.total_time(td(milliseconds=50))
159 | def test_hello_default():
160 | ...
161 | ~~~
162 |
163 | In some cases, you would want to make sure that a function or method called on a
164 | certain line in your test script executes in under a certain amount of time, say
165 | 5% of the total test time. You can achieve this like so
166 |
167 | ~~~ python
168 | import pytest
169 |
170 |
171 | @pytest.mark.total_time("5%", line=7)
172 | def test_hello_default():
173 | somefunction()
174 | fastfunction() # <- this is line no. 7 in the test script
175 | someotherfunction()
176 | ~~~
177 |
178 | In many cases, however, one would want to test that a function or a method
179 | called either directly or indirectly by a test doesn't take more than a certain
180 | overall time to run. This is where the remaining arguments of the ``total_test``
181 | marker come into play. Suppose that you want to profile the procedure ``bar``
182 | that is called by method ``foo`` of an object of type ``Snafu``. To ensure that
183 | ``bar`` doesn't take longer than, say, 50% of the overall test duration, you can
184 | write
185 |
186 | ~~~ python
187 | import pytest
188 |
189 |
190 | @pytest.mark.total_time("50%", function="bar")
191 | def test_snafu():
192 | ...
193 | snafu = Snafu()
194 | ...
195 | snafu.foo()
196 | ...
197 | ~~~
198 |
199 | You can use the `module` argument to resolve function name clashes. For example,
200 | if the definition of the function/method `bar` occurs within the modules
201 | ``somemodule.py`` and ``someothermodule.py``, but you are only interested in the
202 | one defined in ``somemodule.py``, you can change the above into
203 |
204 | ~~~ python
205 | import pytest
206 |
207 |
208 | @pytest.mark.total_time("50%", function="bar", module="somemodule.py")
209 | def test_snafu():
210 | ...
211 | snafu = Snafu()
212 | ...
213 | snafu.foo()
214 | ...
215 | ~~~
216 |
217 | And whilst you can also specify a line number, this is perhaps not very handy
218 | and practical outside of test scripts themselves, unless the content of the
219 | module is stable enough that line numbers don't need to be updated very
220 | frequently.
221 |
222 | When the pluing runs, it will produce an output containing lines of the form
223 |
224 | ~~~
225 | test_austin_time_checks.py::test_lines test_lines:19 (test_austin_time_checks.py) -16.0 ms (-78.2% of 20.5 ms)
226 | ~~~
227 |
228 | In this case, a negative number, such as `-16.0 ms`, indicates that the total
229 | time spent on `test_lines:19 (test_austin_time_checks.py)` was 16.0 ms less
230 | than the total allowed time specified with the `total_time` marker, which in
231 | this example is 20.5 ms. Hence, negative numbers indicate a successful check.
232 |
233 | Failing tests will have a positive delta reported, e.g.
234 |
235 | ~~~
236 | test_austin_time_checks.py::test_check_fails test_check_fails (test_austin_time_checks.py) +99.8 ms (9978.6% of 1000.0 μs)
237 | ~~~
238 |
239 | This indicates that the total time spent on
240 | `test_check_fails (test_austin_time_checks.py)` was 99.8 ms more than the
241 | required threshold, which was set to 1 ms.
242 |
243 | ## Memory checks
244 |
245 | One can perform memory allocation checks with the `total_memory` marker. The
246 | first argument is ``size``, which can be a percentage of the total memory
247 | allocation of the marked test case, as well as an absolute measure of the
248 | maximum amount of memory, e.g., ``"24 MB"``. The ``function``, ``module`` and
249 | ``line`` are the same as for the ``total_time`` marker. The extra ``net``
250 | argument can be set to ``True`` to check for the total _net_ memory usage, that
251 | is the difference between memory allocations and deallocations.
252 |
253 | ~~~ python
254 | import pytest
255 |
256 |
257 | @pytest.mark.total_memory("24 MB")
258 | def test_snafu():
259 | allota_memory()
260 | ~~~
261 |
262 | In order to perform memory checks, you need to specify either the ``memory`` or
263 | ``all`` profile mode via the ``--profile-mode`` option.
264 |
265 | The negative and positive memory deltas reported by the plugin in the report
266 | behave like the time deltas described in the previous section. That is, a
267 | negative memory delta indicates a successful check, whereas a positive delta
268 | indicates a check that has failed.
269 |
270 | ## Mixed checks
271 |
272 | When in the ``all`` profile mode, you can perform both time and memory checks by
273 | stacking ``total_time`` and ``total_memory`` markers.
274 |
275 | ~~~ python
276 | import pytest
277 |
278 |
279 | @pytest.mark.total_time(5.15)
280 | @pytest.mark.total_memory("24 MB")
281 | def test_snafu():
282 | allota_memory_and_time()
283 | ~~~
284 |
285 |
286 | ## Multi-processing
287 |
288 | If your tests spawn other Python processes, you can ask pytest-austin to profile
289 | them too with the ``--minime`` option. Note that if your tests are spawning too
290 | many non-Python processes, the sampling rate might be affected because of the
291 | way that Austin tries to discover Python child processes.
292 |
293 | ## Reporting
294 |
295 | This plugins generate a report on terminal and dumps the collected profiling
296 | statistics on the file system as well, for later analysis and visualisation. The
297 | verbosity of the terminal report can be controlled with the ``--austin-report``
298 | option. By default, it is set to ``minimal``, which means that only checks that
299 | have failed will be reported. Use ``full`` to see the results for all the checks
300 | that have been detected and executed by the plugin.
301 |
302 | Regarding the dump of the profiling statistics, the generated file is in the
303 | Austin format by default (this is a generalisation of the collapsed stack
304 | format). If you want the plugin to dump the data in either the ``pprof`` or
305 | ``speedscope`` format, you can set the ``--profile-format`` option accordingly.
306 |
307 |
308 | # Compatibility
309 |
310 | This plugin has been tested on Linux, MacOS and Windows. Given that it relies on
311 | [Austin](https://github.com/P403n1x87/austin) for sampling the frame stacks of
312 | the pytest process, its compatibility considerations apply to pytest-austin as
313 | well.
314 |
315 | On Linux, the use of ``sudo`` is required, unless the ``CAP_SYS_PTRACE``
316 | capability is granted to the Austin binary with, e.g.
317 |
318 | ~~~ bash
319 | sudo setcap cap_sys_ptrace+ep `which austin`
320 | ~~~
321 |
322 | Then the use of ``sudo`` is no longer required to allow Austin to attach and
323 | sample pytest.
324 |
325 | On MacOS, the use of ``sudo`` is also mandatory, unless the user that is
326 | invoking pytest belongs to the ``procmod`` group.
327 |
328 |
329 | # Contribute
330 |
331 | If you like pytest-austin and you find it useful, there are ways for you to
332 | contribute.
333 |
334 | If you want to help with the development, then have a look at the open issues
335 | and have a look at the [contributing guidelines](CONTRIBUTING.md) before you
336 | open a pull request.
337 |
338 | You can also contribute to the development of the pytest-austin by becoming a
339 | sponsor and/or by [buying me a coffee](https://www.buymeacoffee.com/Q9C1Hnm28)
340 | on BMC or by chipping in a few pennies on
341 | [PayPal.Me](https://www.paypal.me/gtornetta/1).
342 |
343 |
10 |
11 | 
13 |
14 | 
16 | 
22 |
23 |
24 | 
26 |
27 |
28 | 
30 |
31 |
32 | 
34 |
35 |
36 | 
38 |
39 | 
56 |
57 |