| tflink | |
| mkrizek | |
| jskladan |
This config allows you to easily set up old files pruning in all
directories that Taskotron currently uses. I assume it will be mainly
helpful for developers.
This also slightly changes mockchain location in Makefile to make sure
we use something specific to Taskotron and not generic across different
applications/use cases.
codebase not touched, tmpfiles.d config file seems to work in local testing
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
If we add this to git, it should probably be documented. could you add a bit to the readme and docs about the tmpfiles.d config?
| Path | Packages | |||
|---|---|---|---|---|
| M | Makefile (2 lines) | |||
| A | M | conf/tmpfiles.d/taskotron.conf (26 lines) | ||
| M | docs/source/devguide.rst (20 lines) | |||
| M | readme.rst (35 lines) |
| Commit | Tree | Parents | Author | Summary | Date |
|---|---|---|---|---|---|
| b795ddf48436 | d0a923542c14 | f3cb4e022533 | Kamil Páral | tmpfiles.d: add documentation (Show More…) | Feb 26 2015, 12:45 PM |
| f3cb4e022533 | f1f79062567b | fe562f1c7041 | Kamil Páral | add config file for tmpfiles.d (Show More…) | Feb 25 2015, 1:52 PM |
| Show All 27 Lines | |||||
| 28 | DIST:=$(shell rpm --eval '%{dist}') | 28 | DIST:=$(shell rpm --eval '%{dist}') | ||
| 29 | VERSION:=$(shell rpmspec -q --queryformat="%{VERSION}\n" $(SPECFILE) | uniq) | 29 | VERSION:=$(shell rpmspec -q --queryformat="%{VERSION}\n" $(SPECFILE) | uniq) | ||
| 30 | RELEASE:=$(subst $(DIST),,$(shell rpmspec -q --queryformat="%{RELEASE}\n" $(SPECFILE) | uniq)) | 30 | RELEASE:=$(subst $(DIST),,$(shell rpmspec -q --queryformat="%{RELEASE}\n" $(SPECFILE) | uniq)) | ||
| 31 | NVR:=$(SRC)-$(VERSION)-$(RELEASE) | 31 | NVR:=$(SRC)-$(VERSION)-$(RELEASE) | ||
| 32 | GITBRANCH:=$(shell git rev-parse --abbrev-ref HEAD) | 32 | GITBRANCH:=$(shell git rev-parse --abbrev-ref HEAD) | ||
| 33 | TARGETDIST:=fc20 | 33 | TARGETDIST:=fc20 | ||
| 34 | BUILDTARGET=fedora-20-x86_64 | 34 | BUILDTARGET=fedora-20-x86_64 | ||
| 35 | COPRREPO=https://copr-be.cloud.fedoraproject.org/results/tflink/taskotron/fedora-20-x86_64 | 35 | COPRREPO=https://copr-be.cloud.fedoraproject.org/results/tflink/taskotron/fedora-20-x86_64 | ||
| 36 | MOCKCHAINREPO=/var/tmp/mockchain | 36 | MOCKCHAINREPO=/var/tmp/taskotron-mockchain | ||
| 37 | 37 | | |||
| 38 | test: $(VENV) | 38 | test: $(VENV) | ||
| 39 | sh -c "TEST='true' . $(VENV)/bin/activate; py.test --cov $(SRC) testing/; deactivate" | 39 | sh -c "TEST='true' . $(VENV)/bin/activate; py.test --cov $(SRC) testing/; deactivate" | ||
| 40 | 40 | | |||
| 41 | test-ci: $(VENV) | 41 | test-ci: $(VENV) | ||
| 42 | sh -c "TEST='true' . $(VENV)/bin/activate; py.test --cov-report xml --cov $(SRC) testing/; deactivate" | 42 | sh -c "TEST='true' . $(VENV)/bin/activate; py.test --cov-report xml --cov $(SRC) testing/; deactivate" | ||
| 43 | 43 | | |||
| 44 | pylint: | 44 | pylint: | ||
| ▲ Show 20 Lines • Show All 49 Lines • Show Last 20 Lines | |||||
| 1 | # Copy this file into /etc/tmpfiles.d/ in order to have the following | ||||
|---|---|---|---|---|---|
| 2 | # directories cleaned up regularly. Read 'man 5 tmpfiles.d' to understand | ||||
| 3 | # how it works exactly. | ||||
| 4 | # | ||||
| 5 | # This is mainly meant for developers' machines, because on server you probably | ||||
| 6 | # want to handle the old files differently (archive artifacts and rotate logs | ||||
| 7 | # instead of just deleting them). | ||||
| 8 | | ||||
| 9 | | ||||
| 10 | #Type Path Mode UID GID Age Argument | ||||
| 11 | | ||||
| 12 | # workdirs for local execution and other temporary files | ||||
| 13 | d /var/tmp/taskotron 0777 root root 1w - | ||||
| 14 | | ||||
| 15 | # task results and generated files | ||||
| 16 | d /var/lib/taskotron/artifacts 0777 root root 1w - | ||||
| 17 | | ||||
| 18 | # log output; not used for local execution at the moment | ||||
| 19 | d /var/log/taskotron 0777 root root 1w - | ||||
| 20 | | ||||
| 21 | # temporary files created by test suite | ||||
| 22 | d /var/tmp/taskotron-test 0777 root root 1d - | ||||
| 23 | | ||||
| 24 | # mock output from 'make mockchain' | ||||
| 25 | d /var/tmp/taskotron-mockchain 0777 root root 1d - | ||||
| 26 | | ||||
| Show First 20 Lines • Show All 58 Lines • ▼ Show 20 Line(s) | |||||
| 59 | Continuous Integration | 59 | Continuous Integration | ||
| 60 | ^^^^^^^^^^^^^^^^^^^^^^ | 60 | ^^^^^^^^^^^^^^^^^^^^^^ | ||
| 61 | 61 | | |||
| 62 | Ideally, one **should** run unit/functional tests before sending code for review. | 62 | Ideally, one **should** run unit/functional tests before sending code for review. | ||
| 63 | However, it might happen that code that breaks tests gets pushed, for that we | 63 | However, it might happen that code that breaks tests gets pushed, for that we | ||
| 64 | have a basic support for running tests after each commit at | 64 | have a basic support for running tests after each commit at | ||
| 65 | http://qadevel.fedoraproject.org/buildmaster/waterfall. | 65 | http://qadevel.fedoraproject.org/buildmaster/waterfall. | ||
| 66 | 66 | | |||
| 67 | Configuration | ||||
| 68 | ------------- | ||||
| 69 | | ||||
| 70 | The ``libtaskotron-config`` package installs config files with default values | ||||
| 71 | into ``/etc/taskotron``. If you need to change those default values, you can | ||||
| 72 | either change the files in ``/etc/taskotron`` or you can create config files | ||||
| 73 | inside your checkout with:: | ||||
| 74 | | ||||
| 75 | cp conf/taskotron.yaml.example conf/taskotron.yaml | ||||
| 76 | cp conf/yumrepoinfo.conf.example conf/yumrepoinfo.conf | ||||
| 77 | | ||||
| 78 | The configuration files in ``conf/`` take precedence over anything in ``/etc``, | ||||
| 79 | so make sure that you're editing the correct file if you create local copies. | ||||
| 80 | | ||||
| 81 | In the development environment, it's also useful to have taskotron-generated | ||||
| 82 | files automatically cleaned up, so that they don't occupy disk space in vain. | ||||
| 83 | There is a tmpfiles.d template prepared for you, look into ``conf/tmpfiles.d``. | ||||
| 84 | | ||||
| 67 | Support tools | 85 | Support tools | ||
| 68 | ------------- | 86 | ------------- | ||
| 69 | 87 | | |||
| 70 | There are several tools that, while not required, make the process of developing | 88 | There are several tools that, while not required, make the process of developing | ||
| 71 | for libtaskotron significantly easier. | 89 | for libtaskotron significantly easier. | ||
| 72 | 90 | | |||
| 73 | 91 | | |||
| 74 | .. _installing-arcanist: | 92 | .. _installing-arcanist: | ||
| ▲ Show 20 Lines • Show All 319 Lines • Show Last 20 Lines | |||||
| 1 | ============ | 1 | ============ | ||
|---|---|---|---|---|---|
| 2 | libtaskotron | 2 | libtaskotron | ||
| 3 | ============ | 3 | ============ | ||
| 4 | 4 | | |||
| 5 | libtaskotron is a library for running automated tasks as part of the | 5 | libtaskotron is a library for running automated tasks as part of the | ||
| 6 | `Taskotron <https://fedoraproject.org/wiki/Taskotron>` system. It is in very | 6 | `Taskotron <https://fedoraproject.org/wiki/Taskotron>`_ system. It is in very | ||
| 7 | early stages of development with the initial objective of (but not limited to) | 7 | early stages of development with the initial objective of (but not limited to) | ||
| 8 | replacing AutoQA for automating selected package checks in Fedora. | 8 | replacing AutoQA for automating selected package checks in Fedora. | ||
| 9 | 9 | | |||
| 10 | Libtaskotron should be considered as very early alpha code - the features | 10 | Libtaskotron should be considered as very early alpha code - the features | ||
| 11 | contained are generally funcitonal but we will likely continue to make major | 11 | contained are generally funcitonal but we will likely continue to make major | ||
| 12 | changes in how libtaskotron works. | 12 | changes in how libtaskotron works. | ||
| 13 | 13 | | |||
| 14 | Please direct questions and comments to either `#fedora-qa` on freenode or the | 14 | Please direct questions and comments to either *#fedora-qa* on freenode or the | ||
| 15 | `qa-devel mailing list <https://admin.fedoraproject.org/mailman/listinfo/qa-devel>`_. | 15 | `qa-devel mailing list <https://admin.fedoraproject.org/mailman/listinfo/qa-devel>`_. | ||
| 16 | 16 | | |||
| 17 | For more information, please reference the online documentation: | 17 | For more information, please reference the online documentation: | ||
| 18 | 18 | | |||
| 19 | * `Development Version <http://libtaskotron.readthedocs.org/en/develop/>`_ | 19 | * `Development Version <http://libtaskotron.readthedocs.org/en/develop/>`_ | ||
| 20 | 20 | | |||
| 21 | * `Latest Release <http://libtaskotron.readthedocs.org/en/latest/>`_ | 21 | * `Latest Release <http://libtaskotron.readthedocs.org/en/latest/>`_ | ||
| 22 | 22 | | |||
| ▲ Show 20 Lines • Show All 50 Lines • ▼ Show 20 Line(s) | |||||
| 73 | changes to it, the code changes are reflected immediately:: | 73 | changes to it, the code changes are reflected immediately:: | ||
| 74 | 74 | | |||
| 75 | pip install -e . | 75 | pip install -e . | ||
| 76 | 76 | | |||
| 77 | 77 | | |||
| 78 | Configuration | 78 | Configuration | ||
| 79 | ============= | 79 | ============= | ||
| 80 | 80 | | |||
| 81 | The `libtaskotron-config` package installs config files with default values | 81 | The ``libtaskotron-config`` package installs config files with default values | ||
| 82 | into `/etc/taskotron`. To change those default values, you can either change | 82 | into ``/etc/taskotron``. If you need to change those default values, you can | ||
| 83 | the files in `/etc/taskotron` or you can create config files inside your | 83 | either change the files in ``/etc/taskotron`` or you can create config files | ||
| 84 | checkout with:: | 84 | inside your checkout with:: | ||
| 85 | 85 | | |||
| 86 | cp conf/taskotron.yaml.example conf/taskotron.yaml | 86 | cp conf/taskotron.yaml.example conf/taskotron.yaml | ||
| 87 | cp conf/yumrepoinfo.conf.example conf/yumrepoinfo.conf | 87 | cp conf/yumrepoinfo.conf.example conf/yumrepoinfo.conf | ||
| 88 | 88 | | |||
| 89 | The configuration files in `./conf` take precedence over anything in `/etc/`, | 89 | The configuration files in ``conf/`` take precedence over anything in ``/etc``, | ||
| 90 | so make sure that you're editing the correct file if you create local copies. | 90 | so make sure that you're editing the correct file if you create local copies. | ||
| 91 | 91 | | |||
| 92 | In the development environment, it's also useful to have taskotron-generated | ||||
| 93 | files automatically cleaned up, so that they don't occupy disk space in vain. | ||||
| 94 | There is a tmpfiles.d template prepared for you, look into ``conf/tmpfiles.d``. | ||||
| 92 | 95 | | |||
| 93 | Running a Task | 96 | Running a Task | ||
| 94 | ============== | 97 | ============== | ||
| 95 | 98 | | |||
| 96 | A relatively simple example task is `rpmlint <https://bitbucket.org/fedoraqa/task-rpmlint>`_. | 99 | A relatively simple example task is `rpmlint <https://bitbucket.org/fedoraqa/task-rpmlint>`_. | ||
| 97 | 100 | | |||
| 98 | The task requires the rpmlint tool to be installed, so be sure to run:: | 101 | The task requires the rpmlint tool to be installed, so be sure to run:: | ||
| 99 | 102 | | |||
| 100 | sudo yum install rpmlint | 103 | sudo yum install rpmlint | ||
| 101 | 104 | | |||
| 102 | To run that task against a koji build with NEVR `<nevr>` for some arch `<arch>` | 105 | To run that task against a koji build with NEVR ``<nevr>`` for some arch | ||
| 103 | , do the following:: | 106 | ``<arch>``, do the following:: | ||
| 104 | 107 | | |||
| 105 | git clone https://bitbucket.org/fedoraqa/task-rpmlint.git | 108 | git clone https://bitbucket.org/fedoraqa/task-rpmlint.git | ||
| 106 | runtask -i <nevr> -t koji_build -a <arch> task-rpmlint/rpmlint.yml | 109 | runtask -i <nevr> -t koji_build -a <arch> task-rpmlint/rpmlint.yml | ||
| 107 | 110 | | |||
| 108 | This will download the `<nevr>` from koji into a temp directory under `/var/tmp/`, | 111 | This will download the ``<nevr>`` from koji into a temp directory under | ||
| 109 | run rpmlint on the downloaded rpms and print output in TAP format to stdout. | 112 | ``/var/tmp/``, run rpmlint on the downloaded rpms and print output in TAP format | ||
| 113 | to stdout. | ||||
| 110 | 114 | | |||
| 111 | Example:: | 115 | Example:: | ||
| 112 | 116 | | |||
| 113 | runtask -i xchat-2.8.8-21.fc20 -t koji_build -a x86_64 task-rpmlint/rpmlint.yml | 117 | runtask -i xchat-2.8.8-21.fc20 -t koji_build -a x86_64 task-rpmlint/rpmlint.yml | ||
| 114 | 118 | | |||
| 115 | 119 | | |||
| 116 | Running the Test Suite | 120 | Running the Test Suite | ||
| 117 | ====================== | 121 | ====================== | ||
| Show All 10 Lines | |||||
| 128 | to run both unit and functional tests (recommended). Make sure to use the | 132 | to run both unit and functional tests (recommended). Make sure to use the | ||
| 129 | virtualenv-provided version of py.test, not the system one, otherwise you'll | 133 | virtualenv-provided version of py.test, not the system one, otherwise you'll | ||
| 130 | encounter import errors. | 134 | encounter import errors. | ||
| 131 | 135 | | |||
| 132 | You can also see a test coverage of the code, just run:: | 136 | You can also see a test coverage of the code, just run:: | ||
| 133 | 137 | | |||
| 134 | py.test --functional --cov-report term-missing --cov libtaskotron testing/ | 138 | py.test --functional --cov-report term-missing --cov libtaskotron testing/ | ||
| 135 | 139 | | |||
| 136 | A nice HTML-based representation is available if you use `--cov-report html` | 140 | A nice HTML-based representation is available if you use ``--cov-report html`` | ||
| 137 | parameter instead. | 141 | parameter instead. | ||
| 138 | 142 | | |||
| 139 | If you write new tests, be sure to run this to see whether the code is | 143 | If you write new tests, be sure to run this to see whether the code is | ||
| 140 | sufficiently covered by your tests. | 144 | sufficiently covered by your tests. | ||
| 141 | 145 | | |||
| 142 | Building Documentation | 146 | Building Documentation | ||
| 143 | ====================== | 147 | ====================== | ||
| 144 | 148 | | |||
| 145 | Libtaskotron's documentation is written in `reStructuredText | 149 | Libtaskotron's documentation is written in `reStructuredText | ||
| 146 | <http://docutils.sourceforge.net/rst.html>`_ and built using `Sphinx | 150 | <http://docutils.sourceforge.net/rst.html>`_ and built using `Sphinx | ||
| 147 | <http://sphinx-doc.org/>`_. | 151 | <http://sphinx-doc.org/>`_. | ||
| 148 | 152 | | |||
| 149 | The documentation is easy to build if you have followed the instructions to set | 153 | The documentation is easy to build if you have followed the instructions to set | ||
| 150 | up a development environment. | 154 | up a development environment. | ||
| 151 | 155 | | |||
| 152 | To actually build the documentation:: | 156 | To actually build the documentation:: | ||
| 153 | 157 | | |||
| 154 | cd docs/ | 158 | cd docs/ | ||
| 155 | make html | 159 | make html | ||
| 156 | | ||||