EbookFoundation
/
readthedocs.org
mirror of https://github.com/EbookFoundation/readthedocs.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
readthedocs.org/tox.ini

62 lines
1.7 KiB
INI
Raw Normal View History

Add test of tox running test and lint commands, update travis
2015-07-19 03:18:49 +00:00
[tox]
add description for tox tasks For example: default environments: py27 -> run test suite for the application with python2.7 py36 -> run test suite for the application with python3.6 lint -> run linter (prospector) to ensure the source code corresponds to our coding standards docs -> build readthedocs documentation additional environments: coverage -> run test suite with code coverage for the application with /usr/bin/python eslint -> run the JavaScript linter (requires gulp installed)
2018-03-28 08:46:44 +00:00
minversion=2.9.0
More Travis-CI tweakery.
2017-06-01 19:07:51 +00:00
envlist = py{27,36},lint,docs
Add test of tox running test and lint commands, update travis
2015-07-19 03:18:49 +00:00
skipsdist = True
More fixes
2017-06-14 22:51:00 +00:00
[travis]
python =
2.7: py27
Run coverage on travis
2018-09-05 14:45:26 +00:00
3.6: py36, coverage
Finish linting on py3ish code (#2949) * Resolve first round of linting errors in restapi. This is a first step and only adds docstrings, etc. It doesn't refactor any code. Conflicts: prospector-more.yml readthedocs/restapi/views/model_views.py * Reduce unused params. In several cases, we can use the provided `request` rather than access `self` (which could make these functions easier to test in isolation). In others, the unused args could be folded into an unnamed kwarg param. * Don't replace section variable. This worked as intended, but only because the overridden section variable would later evaluate to True. Using a different variable name makes this a bit less error-prone. * Minor docstring update * Fix indent on docstring * Punt on refactoring * Fix call args * Try unpinning testing reqs * Bump up prospector higher level strictness * Linting issues: arguments-differ, len-as-condition, redefined variables * Remove unnecessary elses This addresses no-else-return, which removes a `return` in an `else` after an `if` that already has a `return`. This makes the default return more obvious in most cases. * Fix new linting issues with import order Also, update travis and tox config for multiple versions of python * Another fix on travis envs
2017-06-14 16:38:03 +00:00
Add test of tox running test and lint commands, update travis
2015-07-19 03:18:49 +00:00
[testenv]
add description for tox tasks For example: default environments: py27 -> run test suite for the application with python2.7 py36 -> run test suite for the application with python3.6 lint -> run linter (prospector) to ensure the source code corresponds to our coding standards docs -> build readthedocs documentation additional environments: coverage -> run test suite with code coverage for the application with /usr/bin/python eslint -> run the JavaScript linter (requires gulp installed)
2018-03-28 08:46:44 +00:00
description = run test suite for the application with {basepython}
Add test of tox running test and lint commands, update travis
2015-07-19 03:18:49 +00:00
setenv =
PYTHONPATH={toxinidir}/readthedocs:{toxinidir}
Ability to override the creation of the Celery App (#3623) * Ability to override the creation of the Celery App * Revert "Ability to override the creation of the Celery App" This reverts commit d21649cba4e44c4323fe2d4fcaf67cc2a51ff816. * Use simple settings to reuse the Celery App * Fix Django settings when running tests
2018-02-22 14:49:50 +00:00
DJANGO_SETTINGS_MODULE=readthedocs.settings.test
Update locale on testenv in tox
2015-07-20 08:07:40 +00:00
LANG=C
Set magic environment variable
2018-05-16 21:48:26 +00:00
LC_CTYPE=C.UTF-8
Skip local settings on testing
2018-09-28 16:59:33 +00:00
DJANGO_SETTINGS_SKIP_LOCAL=True
make tests parallelizable using pytest-xdist (#2899) Be ware that running tests in parallel may cause tests to flake. This commit does not make parallel test the default it only makes it possible.
2017-05-24 20:46:40 +00:00
deps = -r{toxinidir}/requirements/testing.txt
Add test of tox running test and lint commands, update travis
2015-07-19 03:18:49 +00:00
changedir = {toxinidir}/readthedocs
commands =
Run coverage on travis
2018-09-05 14:45:26 +00:00
py.test --cov-report= --cov-config {toxinidir}/.coveragerc --cov=. {posargs}
More tox config
2015-07-19 07:03:55 +00:00
[testenv:docs]
add description for tox tasks For example: default environments: py27 -> run test suite for the application with python2.7 py36 -> run test suite for the application with python3.6 lint -> run linter (prospector) to ensure the source code corresponds to our coding standards docs -> build readthedocs documentation additional environments: coverage -> run test suite with code coverage for the application with /usr/bin/python eslint -> run the JavaScript linter (requires gulp installed)
2018-03-28 08:46:44 +00:00
description = build readthedocs documentation
More tox config
2015-07-19 07:03:55 +00:00
changedir = {toxinidir}/docs
commands =
Don't change tox yet, just fix this bug
2018-05-30 18:53:51 +00:00
sphinx-build -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
Add test of tox running test and lint commands, update travis
2015-07-19 03:18:49 +00:00
Move to separate env
2018-02-21 17:27:10 +00:00
[testenv:docs-lint]
Add description to tox env
2018-05-23 04:27:42 +00:00
description = run linter (rstcheck) to ensure there aren't errors on our docs
Use new requirements file
2018-02-21 18:24:40 +00:00
deps = -r{toxinidir}/requirements/docs-lint.txt
Move to separate env
2018-02-21 17:27:10 +00:00
changedir = {toxinidir}/docs
commands =
Check files with recursive option
2018-02-24 23:17:03 +00:00
rstcheck -r .
Move to separate env
2018-02-21 17:27:10 +00:00
Add test of tox running test and lint commands, update travis
2015-07-19 03:18:49 +00:00
[testenv:lint]
add description for tox tasks For example: default environments: py27 -> run test suite for the application with python2.7 py36 -> run test suite for the application with python3.6 lint -> run linter (prospector) to ensure the source code corresponds to our coding standards docs -> build readthedocs documentation additional environments: coverage -> run test suite with code coverage for the application with /usr/bin/python eslint -> run the JavaScript linter (requires gulp installed)
2018-03-28 08:46:44 +00:00
description = run linter (prospector) to ensure the source code corresponds to our coding standards
Speed up build process (#2312) * We don't need all dependecies to run 'tox -e lint' * We don't really use pytest-django but it wouldn't hurt setting --reuse-db * coveralls doesn't seem to be working at the moment so I removed it * Delete unused runtests.sh. 'tox -e py27' already does the same job. * Cache all dependencies in Travis CI
2016-07-18 18:31:37 +00:00
deps = -r{toxinidir}/requirements/lint.txt
Add test of tox running test and lint commands, update travis
2015-07-19 03:18:49 +00:00
commands =
Add stricter linting to prospector as second pass
2017-03-21 18:39:00 +00:00
prospector \
--profile-path={toxinidir} \
--profile=prospector-more \
Finish linting on py3ish code (#2949) * Resolve first round of linting errors in restapi. This is a first step and only adds docstrings, etc. It doesn't refactor any code. Conflicts: prospector-more.yml readthedocs/restapi/views/model_views.py * Reduce unused params. In several cases, we can use the provided `request` rather than access `self` (which could make these functions easier to test in isolation). In others, the unused args could be folded into an unnamed kwarg param. * Don't replace section variable. This worked as intended, but only because the overridden section variable would later evaluate to True. Using a different variable name makes this a bit less error-prone. * Minor docstring update * Fix indent on docstring * Punt on refactoring * Fix call args * Try unpinning testing reqs * Bump up prospector higher level strictness * Linting issues: arguments-differ, len-as-condition, redefined variables * Remove unnecessary elses This addresses no-else-return, which removes a `return` in an `else` after an `if` that already has a `return`. This makes the default return more obvious in most cases. * Fix new linting issues with import order Also, update travis and tox config for multiple versions of python * Another fix on travis envs
2017-06-14 16:38:03 +00:00
--die-on-tool-error {posargs}
Add test of tox running test and lint commands, update travis
2015-07-19 03:18:49 +00:00
prospector \
--profile-path={toxinidir} \
--profile=prospector \
Finish linting on py3ish code (#2949) * Resolve first round of linting errors in restapi. This is a first step and only adds docstrings, etc. It doesn't refactor any code. Conflicts: prospector-more.yml readthedocs/restapi/views/model_views.py * Reduce unused params. In several cases, we can use the provided `request` rather than access `self` (which could make these functions easier to test in isolation). In others, the unused args could be folded into an unnamed kwarg param. * Don't replace section variable. This worked as intended, but only because the overridden section variable would later evaluate to True. Using a different variable name makes this a bit less error-prone. * Minor docstring update * Fix indent on docstring * Punt on refactoring * Fix call args * Try unpinning testing reqs * Bump up prospector higher level strictness * Linting issues: arguments-differ, len-as-condition, redefined variables * Remove unnecessary elses This addresses no-else-return, which removes a `return` in an `else` after an `if` that already has a `return`. This makes the default return more obvious in most cases. * Fix new linting issues with import order Also, update travis and tox config for multiple versions of python * Another fix on travis envs
2017-06-14 16:38:03 +00:00
--die-on-tool-error {posargs}
Add tox target to generate coverage reports
2017-05-23 18:17:48 +00:00
Add eslint using the airbnb config. (#2905) * Add eslint using the airbnb config. In an effort to make the JS consistent, this adds an ESLint gulp task. ESLint is *very* configurable, and has no defaults. Instead, this reaches for airbnb's legacy config (which covers ES5), which is one of the most popular configurations. As a last step, it turns off all of the rules which currently fail. We can turn them on piecemeal, or override the airbnb style to use a different format. Rules to prioritize (as they likely indicate bugs): * "array-callback-return": "off", * "eqeqeq": "off", * "guard-for-in": "off", * "no-inner-declarations": "off", * "no-loop-func": "off", * "no-mixed-operators": "off", * "no-undef": "off", * "no-use-before-define": "off", * "one-var": "off", * Lint frontend in Travis. This adds an ESLint step to the CI service so we prevent unlinted code from making its way in. * Create an ESLint tox env. By adding a tox env for eslint, we allow users to run it locally as part of tox runs. Thanks for the suggestion @ericholscher! * Fix tox call to gulp lint task
2017-05-24 23:12:33 +00:00
[testenv:eslint]
Use "npm run lint" from tox (#4312) * Use "npm run lint" from tox * Don't need gulp anymore for CI
2018-07-05 15:52:33 +00:00
description = run the JavaScript linter (requires `npm install`)
Add eslint using the airbnb config. (#2905) * Add eslint using the airbnb config. In an effort to make the JS consistent, this adds an ESLint gulp task. ESLint is *very* configurable, and has no defaults. Instead, this reaches for airbnb's legacy config (which covers ES5), which is one of the most popular configurations. As a last step, it turns off all of the rules which currently fail. We can turn them on piecemeal, or override the airbnb style to use a different format. Rules to prioritize (as they likely indicate bugs): * "array-callback-return": "off", * "eqeqeq": "off", * "guard-for-in": "off", * "no-inner-declarations": "off", * "no-loop-func": "off", * "no-mixed-operators": "off", * "no-undef": "off", * "no-use-before-define": "off", * "one-var": "off", * Lint frontend in Travis. This adds an ESLint step to the CI service so we prevent unlinted code from making its way in. * Create an ESLint tox env. By adding a tox env for eslint, we allow users to run it locally as part of tox runs. Thanks for the suggestion @ericholscher! * Fix tox call to gulp lint task
2017-05-24 23:12:33 +00:00
commands =
Use "npm run lint" from tox (#4312) * Use "npm run lint" from tox * Don't need gulp anymore for CI
2018-07-05 15:52:33 +00:00
npm run lint
Add tox target to generate coverage reports
2017-05-23 18:17:48 +00:00
[testenv:coverage]
add description for tox tasks For example: default environments: py27 -> run test suite for the application with python2.7 py36 -> run test suite for the application with python3.6 lint -> run linter (prospector) to ensure the source code corresponds to our coding standards docs -> build readthedocs documentation additional environments: coverage -> run test suite with code coverage for the application with /usr/bin/python eslint -> run the JavaScript linter (requires gulp installed)
2018-03-28 08:46:44 +00:00
description = run test suite with code coverage for the application with {basepython}
Run coverage on travis
2018-09-05 14:45:26 +00:00
deps = coverage
Add tox target to generate coverage reports
2017-05-23 18:17:48 +00:00
whitelist_externals = echo
commands =
Don't report some files on coverage
2018-09-05 16:04:05 +00:00
coverage report --show-missing --fail-under=76
Add tox target to generate coverage reports
2017-05-23 18:17:48 +00:00
echo Annotated HTML coverage report is in {toxinidir}/readthedocs/htmlcov/index.html