Differential D1114

improve install and testing process
ClosedPublic
Actions

Authored by kparal on Feb 6 2017, 2:56 PM.

Details

Reviewers
jskladan
Group Reviewers
resultsdb
Commits
rRSDBbf5dc52c714b: improve install and testing process
Summary

Another take on this after D1112. Recommend --system-site-packages by
default, because it's the simplest approach. Tell how to install RPM
deps if preffered. Print coverage when running the test suite.

Test Plan

Tested pytest and make test using the new instructions.

Diff Detail

Repository
rRSDB resultsdb
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
kparal retitled this revision from to improve install and testing process.Feb 6 2017, 2:56 PM
kparal updated this object.
kparal edited the test plan for this revision. (Show Details)
kparal added a reviewer: resultsdb.
kparal updated this revision to Diff 2842.Feb 6 2017, 3:13 PM

use builddep

kparal updated this revision to Diff 2845.Feb 6 2017, 3:52 PM

make makefile targets phony (otherwise make virtualenv works only the first time, then it skips and does not update)

jskladan added a subscriber: jskladan.Feb 7 2017, 8:11 AM

Awesome, I like this. Looks like a reasonable middle way to solve the issues.
Thanks a lot for tackling this!

jskladan accepted this revision.Feb 7 2017, 8:11 AM
jskladan added a reviewer: jskladan.
This revision is now accepted and ready to land.Feb 7 2017, 8:11 AM
Closed by commit rRSDBbf5dc52c714b: improve install and testing process (authored by Kamil Páral <kparal@redhat.com>). · Explain WhyFeb 7 2017, 8:22 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathPackages
MMakefile (26 lines)
MREADME.md (21 lines)
Mrequirements.txt (5 lines)
Mtox.ini (2 lines)

Diff 2848

View Options

Makefile

Show All 27 Lines
28DIST:=$(shell rpm --eval '%{dist}') 28​DIST:=$(shell rpm --eval '%{dist}')
29VERSION:=$(shell rpmspec -q --queryformat="%{VERSION}\n" $(SPECFILE) | uniq) 29​VERSION:=$(shell rpmspec -q --queryformat="%{VERSION}\n" $(SPECFILE) | uniq)
30RELEASE:=$(subst $(DIST),,$(shell rpmspec -q --queryformat="%{RELEASE}\n" $(SPECFILE) | uniq)) 30​RELEASE:=$(subst $(DIST),,$(shell rpmspec -q --queryformat="%{RELEASE}\n" $(SPECFILE) | uniq))
31NVR:=$(SRC)-$(VERSION)-$(RELEASE) 31​NVR:=$(SRC)-$(VERSION)-$(RELEASE)
32GITBRANCH:=$(shell git rev-parse --abbrev-ref HEAD) 32​GITBRANCH:=$(shell git rev-parse --abbrev-ref HEAD)
33TARGETDIST:=fc25 33​TARGETDIST:=fc25
34BUILDTARGET=fedora-25-x86_64 34​BUILDTARGET=fedora-25-x86_64
35 35​
36​.PHONY: test
36test: $(VENV) 37​test: $(VENV)
37 sh -c "set -e; . $(VENV)/bin/activate; python setup.py develop; TEST='true' py.test --cov $(SRC); deactivate" 38​ sh -c "set -e; . $(VENV)/bin/activate; python setup.py develop; \
39​ TEST='true' py.test --cov-report=term-missing --cov $(SRC); deactivate"
38 40​
41​.PHONY: test-ci
39test-ci: $(VENV) 42​test-ci: $(VENV)
40 sh -c "set -e; . $(VENV)/bin/activate; python setup.py develop; TEST='true' py.test --cov-report xml --cov $(SRC); deactivate" 43​ sh -c "set -e; . $(VENV)/bin/activate; python setup.py develop; \
44​ TEST='true' py.test --cov-report=xml --cov $(SRC); deactivate"
41 45​
46​.PHONY: pylint
42pylint: 47​pylint:
43 pylint -f parseable $(SRC) | tee pylint.out 48​ pylint -f parseable $(SRC) | tee pylint.out
44 49​
50​.PHONY: pep8
45pep8: 51​pep8:
46 pep8 $(SRC)/*.py $(SRC)/*/*.py | tee pep8.out 52​ pep8 $(SRC)/*.py $(SRC)/*/*.py | tee pep8.out
47 53​
54​.PHONY: ci
48ci: test-ci pylint pep8 55​ci: test-ci pylint pep8
49 56​
57​.PHONY: docs
50docs: 58​docs:
51 sphinx-build -b html -d docs/_build/doctrees docs/source docs/_build/html 59​ sphinx-build -b html -d docs/_build/doctrees docs/source docs/_build/html
52 60​
61​.PHONY: clean
53clean: 62​clean:
54 rm -rf dist 63​ rm -rf dist
55 rm -rf resultsdb.egg-info 64​ rm -rf resultsdb.egg-info
56 rm -rf build 65​ rm -rf build
57 rm -f pep8.out 66​ rm -f pep8.out
58 rm -f pylint.out 67​ rm -f pylint.out
59 68​
69​.PHONY: archive
60archive: $(SRC)-$(VERSION).tar.gz 70​archive: $(SRC)-$(VERSION).tar.gz
61 71​
72​.PHONY: $(SRC)-$(VERSION).tar.gz
62$(SRC)-$(VERSION).tar.gz: 73​$(SRC)-$(VERSION).tar.gz:
63 git archive $(GITBRANCH) --prefix=$(SRC)-$(VERSION)/ | gzip -c9 > $@ 74​ git archive $(GITBRANCH) --prefix=$(SRC)-$(VERSION)/ | gzip -c9 > $@
64 75​
76​.PHONY: mocksrpm
65mocksrpm: archive 77​mocksrpm: archive
66 mock -r $(BUILDTARGET) --buildsrpm --spec $(SPECFILE) --sources . 78​ mock -r $(BUILDTARGET) --buildsrpm --spec $(SPECFILE) --sources .
67 cp /var/lib/mock/$(BUILDTARGET)/result/$(NVR).$(TARGETDIST).src.rpm . 79​ cp /var/lib/mock/$(BUILDTARGET)/result/$(NVR).$(TARGETDIST).src.rpm .
68 80​
81​.PHONY: mockbuild
69mockbuild: mocksrpm 82​mockbuild: mocksrpm
70 mock -r $(BUILDTARGET) --no-clean --rebuild $(NVR).$(TARGETDIST).src.rpm 83​ mock -r $(BUILDTARGET) --no-clean --rebuild $(NVR).$(TARGETDIST).src.rpm
71 cp /var/lib/mock/$(BUILDTARGET)/result/$(NVR).$(TARGETDIST).noarch.rpm . 84​ cp /var/lib/mock/$(BUILDTARGET)/result/$(NVR).$(TARGETDIST).noarch.rpm .
72 85​
86​#.PHONY: kojibuild
73#kojibuild: mocksrpm 87​#kojibuild: mocksrpm
74# koji build --scratch dist-6E-epel-testing-candidate $(NVR).$(TARGETDIST).src.rpm 88​# koji build --scratch dist-6E-epel-testing-candidate $(NVR).$(TARGETDIST).src.rpm
75 89​
90​.PHONY: nvr
76nvr: 91​nvr:
77 @echo $(NVR) 92​ @echo $(NVR)
78 93​
94​.PHONY: cleanvenv
79cleanvenv: 95​cleanvenv:
80 rm -rf $(VENV) 96​ rm -rf $(VENV)
81 97​
98​.PHONY: virtualenv
82virtualenv: $(VENV) 99​virtualenv: $(VENV)
83 100​
101​.PHONY: $(VENV)
84$(VENV): 102​$(VENV):
85 virtualenv --distribute --system-site-packages $(VENV) 103​ virtualenv --system-site-packages $(VENV)
86 sh -c "set -e; . $(VENV)/bin/activate; pip install --force-reinstall -r requirements.txt; deactivate" 104​ sh -c "set -e; . $(VENV)/bin/activate; pip install -r requirements.txt; deactivate"
View Options

README.md

Show All 9 Lines
10 10​
11## Quick development setup 11​## Quick development setup
12 12​
13First, clone the repository. 13​First, clone the repository.
14 14​
15Then, setup a virtual environment for development: 15​Then, setup a virtual environment for development:
16 16​
17 $ sudo dnf install python-virtualenv 17​ $ sudo dnf install python-virtualenv
18 $ virtualenv env_resultsdb 18​ $ virtualenv --system-site-packages env_resultsdb
19 $ source env_resultsdb/bin/activate 19​ $ source env_resultsdb/bin/activate
20 $ pip install -r requirements.txt 20​ $ pip install -r requirements.txt
21 21​
22​If you encounter any installation issues, it's possible that you don't have
23​`gcc` and necessary C development headers installed to compile C extensions
24​from PyPI. Either install those based on the error messages, or install
25​the necessary packages directly to your system:
26​
27​ $ sudo dnf builddep resultsdb.spec
28​
29​Install the project:
30​
31​ $ python setup.py develop
32​
22Initialize your database: 33​Initialize your database:
23 34​
24 $ DEV=true ./init_db.sh 35​ $ DEV=true ./init_db.sh
25 36​
26Run the server: 37​Run the server:
27 38​
28 $ DEV=true python runapp.py 39​ $ DEV=true python runapp.py
29 40​
Show All 15 Lines55set the following value::
45 56​
46 resultsdb_server: http://localhost:5001/api/v2.0 57​ resultsdb_server: http://localhost:5001/api/v2.0
47 58​
48You might also need to adjust `reporting_enabled` and `report_to_resultsdb`, 59​You might also need to adjust `reporting_enabled` and `report_to_resultsdb`,
49depending on your local settings. 60​depending on your local settings.
50 61​
51## Running test suite 62​## Running test suite
52 63​
53You can run this test suite with the following command (with virtualenv active):: 64​You can run the test suite with the following command (with virtualenv
65​active)::
54 66​
55 $ pytest 67​ $ pytest
56 ​
57or with this command (without virtualenv active):: ​
58 ​
59 $ make test ​
60 ​
View Options

requirements.txt

1# This is a list of pypi packages to be installed into virtualenv. Alternatively, 1​# This is a list of pypi packages to be installed into virtualenv. Alternatively,
2# you can install these as RPMs instead of pypi packages. Use 2​# you can install these as RPMs instead of pypi packages. Use
3# `rpmspec -q --requires resultsdb.spec` 3​# `sudo dnf builddep resultsdb.spec`
4 4​
5# A note for maintainers: Please keep this list in sync with resultsdb.spec. 5​# A note for maintainers: Please keep this list in sync with resultsdb.spec.
6# You should require exact versions here (in order to define an exact working 6​# You should require exact versions here (in order to define an exact working
7# environment), and require a minimal version in the spec file (in order to allow 7​# environment), and require a minimal version in the spec file (in order to allow
8# the libraries to have some minor version bumps during the Fedora release 8​# the libraries to have some minor version bumps during the Fedora release
9# lifecycle). If the Fedora libraries span multiple versions across releases, 9​# lifecycle). If the Fedora libraries span multiple versions across releases,
10# you can define a dependency range here instead of an exact version. 10​# you can define a dependency range here instead of an exact version.
11 11​
12# This list is in the same order as the requirements in the specfile. 12​# This list is in the same order as the requirements in the specfile.
13 13​
14 ​
15fedmsg == 0.17.2 14​fedmsg == 0.17.2
16alembic == 0.8.3 15​alembic == 0.8.3
17Flask == 0.10.1 16​Flask == 0.10.1
18Flask-RESTful == 0.3.5 17​Flask-RESTful == 0.3.5
19Flask-SQLAlchemy == 2.1 18​Flask-SQLAlchemy == 2.1
20iso8601 == 0.1.11 19​iso8601 == 0.1.11
21six == 1.10.0 20​six == 1.10.0
22SQLAlchemy >= 0.9.8 21​SQLAlchemy >= 0.9.8
23WTForms == 2.0 22​WTForms == 2.0
24 23​
24​# Test suite requirements
25​
25pytest >= 2.4.2 26​pytest >= 2.4.2
26pytest-cov >= 1.6 27​pytest-cov >= 1.6
View Options

tox.ini

1# This is a common file where different test suites/linters can be configured. 1​# This is a common file where different test suites/linters can be configured.
2# Phabricator uses this file when running `arc unit` or `arc lint`. 2​# Phabricator uses this file when running `arc unit` or `arc lint`.
3 3​
4[flake8] 4​[flake8]
5max-line-length=99 5​max-line-length=99
6 6​
7[pep8] 7​[pep8]
8max-line-length=99 8​max-line-length=99
9 9​
10[pytest] 10​[pytest]
11minversion=2.0 11​minversion=2.0
12python_functions=test should 12​python_functions=test should
13python_files=test_* functest_* 13​python_files=test_* functest_*
14addopts=--functional testing/ 14​addopts=--functional testing/ --cov resultsdb --cov-report=term-missing