PR#76: Replace dist-git references to master branches with rawhide + Fix Python examples links - fedora-ci/docs

fedora-ci / docs

#76 Replace dist-git references to master branches with rawhide + Fix Python examples links

Merged 2 years ago by bookwar. Opened 2 years ago by churchyard.

fedora-ci/ churchyard/docs rawhide-links into master

Fix Python examples links

Miro Hrončok • 2 years ago

775073c

Replace dist-git references to master branches with rawhide

Miro Hrončok • 2 years ago

52e1f58

modules/ROOT/pages/examples.adoc

file modified

+27 -26

		`@@ -36,31 +36,32 @@`

		`The test repo contains basic smoke test for virtualenv together with example test https://pagure.io/fedora-ci/metadata[Metadata] stored in the https://fedoraproject.org/wiki/Flexible_Metadata_Format[Flexible Metadata Format]:`

		`- * https://src.fedoraproject.org/tests/python/blob/master/f/main.fmf[main.fmf]`
		`- * https://src.fedoraproject.org/tests/python/blob/master/f/smoke/venv.fmf[venv.fmf]`
		`+ * https://src.fedoraproject.org/tests/python/blob/main/f/main.fmf[main.fmf]`
		`+ * https://src.fedoraproject.org/tests/python/blob/main/f/smoke/venv.fmf[venv.fmf]`

		`Once the test is avaible in the share test repository it can be easily linked from supported Python versions:`

		`- * https://src.fedoraproject.org/rpms/python2/blob/master/f/tests/tests.yml[python2],`
		`- https://src.fedoraproject.org/rpms/python26/blob/master/f/tests/tests.yml[python26]`
		`+ * https://src.fedoraproject.org/rpms/python2.7/blob/rawhide/f/tests/tests.yml[python2.7]`

		`- * https://src.fedoraproject.org/rpms/python3/blob/master/f/tests/tests.yml[python3],`
		`- https://src.fedoraproject.org/rpms/python34/blob/master/f/tests/tests.yml[python34],`
		`- https://src.fedoraproject.org/rpms/python35/blob/master/f/tests/tests.yml[python35],`
		`- https://src.fedoraproject.org/rpms/python36/blob/master/f/tests/tests.yml[python36]`
		`+ * https://src.fedoraproject.org/rpms/python3.6/blob/rawhide/f/tests/tests.yml[python3.6],`
		`+ https://src.fedoraproject.org/rpms/python3.7/blob/rawhide/f/tests/tests.yml[python3.7],`
		`+ https://src.fedoraproject.org/rpms/python3.8/blob/rawhide/f/tests/tests.yml[python3.8],`
		`+ https://src.fedoraproject.org/rpms/python3.9/blob/rawhide/f/tests/tests.yml[python3.9],`
		`+ https://src.fedoraproject.org/rpms/python3.10/blob/rawhide/f/tests/tests.yml[python3.10],`
		`+ https://src.fedoraproject.org/rpms/python3.11/blob/rawhide/f/tests/tests.yml[python3.11]`

		`We test additional Python implementations as well:`

		`- * https://src.fedoraproject.org/rpms/pypy/blob/master/f/tests/tests.yml[pypy],`
		`- https://src.fedoraproject.org/rpms/pypy3/blob/master/f/tests/tests.yml[pypy3]`
		`+ * https://src.fedoraproject.org/rpms/pypy/blob/rawhide/f/tests/tests.yml[pypy],`
		`+ https://src.fedoraproject.org/rpms/pypy3.7/blob/rawhide/f/tests/tests.yml[pypy3.7]`

		Plus we ensure that essential tools for venv and virtualnv, such as `setuptools`, `pip` or `virtualenv` itself correctly work with all supported versions:

		`- * https://src.fedoraproject.org/rpms/python-pip/blob/master/f/tests/tests.yml[python-pip]`
		`- * https://src.fedoraproject.org/rpms/python-wheel/blob/master/f/tests/tests.yml[python-wheel]`
		`- * https://src.fedoraproject.org/rpms/python-setuptools/blob/master/f/tests/tests.yml[python-setuptools]`
		`- * https://src.fedoraproject.org/rpms/python-virtualenv/blob/master/f/tests/tests.yml[python-virtualenv]`
		`- * https://src.fedoraproject.org/rpms/python-tox/blob/master/f/tests/tests.yml[python-tox]`
		`+ * https://src.fedoraproject.org/rpms/python-pip/blob/rawhide/f/tests/tests.yml[python-pip]`
		`+ * https://src.fedoraproject.org/rpms/python-wheel/blob/rawhide/f/tests/tests.yml[python-wheel]`
		`+ * https://src.fedoraproject.org/rpms/python-setuptools/blob/rawhide/f/tests/tests.yml[python-setuptools]`
		`+ * https://src.fedoraproject.org/rpms/python-virtualenv/blob/rawhide/f/tests/tests.yml[python-virtualenv]`
		`+ * https://src.fedoraproject.org/rpms/python-tox/blob/rawhide/f/tests/tests.yml[python-tox]`

		`Note that for the last set of examples we run the same test several times with modified environment.`
		`For example:`
		`@@ -96,11 +97,11 @@`

		These tests are then linked from all relevant `tests.yml` files:

		`- * https://src.fedoraproject.org/rpms/bash/blob/master/f/tests/tests.yml[bash]`
		`- * https://src.fedoraproject.org/rpms/ksh/blob/master/f/tests/tests.yml[ksh]`
		`- * https://src.fedoraproject.org/rpms/mksh/blob/master/f/tests/tests.yml[mksh]`
		`- * https://src.fedoraproject.org/rpms/zsh/blob/master/f/tests/tests.yml[zsh]`
		`- * https://src.fedoraproject.org/rpms/dash/blob/master/f/tests/tests.yml[dash]`
		`+ * https://src.fedoraproject.org/rpms/bash/blob/rawhide/f/tests/tests.yml[bash]`
		`+ * https://src.fedoraproject.org/rpms/ksh/blob/rawhide/f/tests/tests.yml[ksh]`
		`+ * https://src.fedoraproject.org/rpms/mksh/blob/rawhide/f/tests/tests.yml[mksh]`
		`+ * https://src.fedoraproject.org/rpms/zsh/blob/rawhide/f/tests/tests.yml[zsh]`
		`+ * https://src.fedoraproject.org/rpms/dash/blob/rawhide/f/tests/tests.yml[dash]`

		`https://fedoraproject.org/wiki/Flexible_Metadata_Format[Flexible Metadata Format] filter is used to select appropriate tests instead of listing individual tests manually.`
		Environment variables `PACKAGES` and `SH_BIN` are used to specify which shell implementation is being tested:
		`@@ -167,12 +168,12 @@`

		`The following six components are covered:`

		`- * https://src.fedoraproject.org/rpms/checkpolicy/blob/master/f/tests/tests.yml[checkpolicy]`
		`- * https://src.fedoraproject.org/rpms/libselinux/blob/master/f/tests/tests.yml[libselinux]`
		`- * https://src.fedoraproject.org/rpms/libsemanage/blob/master/f/tests/tests.yml[libsemanage]`
		`- * https://src.fedoraproject.org/rpms/libsepol/blob/master/f/tests/tests.yml[libsepol]`
		`- * https://src.fedoraproject.org/rpms/policycoreutils/blob/master/f/tests/tests.yml[policycoreutils]`
		`- * https://src.fedoraproject.org/rpms/selinux-policy/blob/master/f/tests/tests.yml[selinux-policy]`
		`+ * https://src.fedoraproject.org/rpms/checkpolicy/blob/rawhide/f/tests/tests.yml[checkpolicy]`
		`+ * https://src.fedoraproject.org/rpms/libselinux/blob/rawhide/f/tests/tests.yml[libselinux]`
		`+ * https://src.fedoraproject.org/rpms/libsemanage/blob/rawhide/f/tests/tests.yml[libsemanage]`
		`+ * https://src.fedoraproject.org/rpms/libsepol/blob/rawhide/f/tests/tests.yml[libsepol]`
		`+ * https://src.fedoraproject.org/rpms/policycoreutils/blob/rawhide/f/tests/tests.yml[policycoreutils]`
		`+ * https://src.fedoraproject.org/rpms/selinux-policy/blob/rawhide/f/tests/tests.yml[selinux-policy]`

		Use the `fmf` command line tool to quickly check which tests will be scheduled:

modules/ROOT/pages/quick-start-guide.adoc

file modified

+2 -2

		`@@ -22,7 +22,7 @@`

		`cd bash/tests/`

		`- Test coverage to be executed together with the basic set of metadata is described in the https://src.fedoraproject.org/rpms/bash/blob/master/f/tests/tests.yml[tests.yml] playbook.`
		`+ Test coverage to be executed together with the basic set of metadata is described in the https://src.fedoraproject.org/rpms/bash/blob/rawhide/f/tests/tests.yml[tests.yml] playbook.`
		Use `ansible-playbook` to run all available tests for the classic environment on the local host (needs to be run as root):

		`ansible-playbook --tags=classic tests.yml`
		`@@ -153,7 +153,7 @@`
		`[3] https://docs.fedoraproject.org/en-US/ci`
		`----`

		- Create a new pull request from your `tests` branch against the master branch in the https://src.fedoraproject.org/fork/psss/rpms/bash[Pagure] web interface.
		+ Create a new pull request from your `tests` branch against the rawhide branch in the https://src.fedoraproject.org/fork/psss/rpms/bash[Pagure] web interface.
		`You might want to include an additional info about the tests such as:`

		`[source,message]`

modules/ROOT/pages/share-test-code.adoc

file modified

+7 -7

		`@@ -77,7 +77,7 @@`
		`- python37`
		`----`

		- The example above is a simplified version of the https://src.fedoraproject.org/tests/python/blob/master/f/tests.yml[tests.yml] file from the Python shared test repo and shows how to enable `smoke` test to be executed against three versions of the Python interpreter.
		+ The example above is a simplified version of the https://src.fedoraproject.org/tests/python/blob/main/f/tests.yml[tests.yml] file from the Python shared test repo and shows how to enable `smoke` test to be executed against three versions of the Python interpreter.

		`== Examples ==`

		`@@ -99,7 +99,7 @@`

		`* https://src.fedoraproject.org/tests/shell`

		`- Bash https://src.fedoraproject.org/rpms/bash/blob/master/f/tests/tests.yml[tests.yml]:`
		`+ Bash https://src.fedoraproject.org/rpms/bash/blob/rawhide/f/tests/tests.yml[tests.yml]:`

		`[source,ansible]`
		`----`
		`@@ -120,7 +120,7 @@`
		`- which # smoke requires which`
		`----`

		`- Ksh https://src.fedoraproject.org/rpms/ksh/blob/master/f/tests/tests.yml[tests.yml]:`
		`+ Ksh https://src.fedoraproject.org/rpms/ksh/blob/rawhide/f/tests/tests.yml[tests.yml]:`

		`[source,ansible]`
		`----`
		`@@ -160,10 +160,10 @@`

		`Several SELinux user space components are sharing test coverage in a single https://src.fedoraproject.org/tests/selinux.git[selinux] test repository:`

		`- * https://src.fedoraproject.org/rpms/libsepol/blob/master/f/tests/tests.yml[libsepol]`
		`- * https://src.fedoraproject.org/rpms/libselinux/blob/master/f/tests/tests.yml[libselinux]`
		`- * https://src.fedoraproject.org/rpms/libsemanage/blob/master/f/tests/tests.yml[libsemanage]`
		`- * https://src.fedoraproject.org/rpms/libsepol/blob/master/f/tests/tests.yml[policycoreutils]`
		`+ * https://src.fedoraproject.org/rpms/libsepol/blob/rawhide/f/tests/tests.yml[libsepol]`
		`+ * https://src.fedoraproject.org/rpms/libselinux/blob/rawhide/f/tests/tests.yml[libselinux]`
		`+ * https://src.fedoraproject.org/rpms/libsemanage/blob/rawhide/f/tests/tests.yml[libsemanage]`
		`+ * https://src.fedoraproject.org/rpms/libsepol/blob/rawhide/f/tests/tests.yml[policycoreutils]`

		`== Start ==`

modules/ROOT/pages/tests.adoc

file modified

+1 -1

		`@@ -66,7 +66,7 @@`
		`It is possible to separate tests into multiple playbooks, each of them can represent a test or a part of a test.`
		Testing system will run each playbook matching the glob `tests/tests*.yml` separately in a clean environment.
		Optionally you can have multiple playbooks without the `tests` prefix and link them from the `tests.yml` file.
		`- Let's have a look at the https://src.fedoraproject.org/rpms/gzip/blob/master/f/tests[gzip] example:`
		`+ Let's have a look at the https://src.fedoraproject.org/rpms/gzip/blob/rawhide/f/tests[gzip] example:`

		`> fedpkg clone -a gzip`
		`Cloning into 'gzip'...`