From 11d6ce19e43e0a2e4806e8fc2b22607953dcde3f Mon Sep 17 00:00:00 2001 From: Sergey Fokin Date: Fri, 8 Jan 2021 15:56:32 +0300 Subject: [PATCH] init commit Change-Id: Iaed7fa268ff73122b78406576e5d1bed6a977571 --- .gitignore | 15 + AUTHORS | 16 + COPYING | 14 + GPL | 339 ++ MANIFEST.in | 15 + Makefile | 113 + README.md | 37 + TODO | 75 + contrib/yum-dnf-compare/README | 19 + .../yum-dnf-compare/pungi-compare-depsolving | 63 + contrib/yum-dnf-compare/run-dnf.sh | 24 + contrib/yum-dnf-compare/run-yum.sh | 28 + doc/Makefile | 177 + doc/_static/.keep | 0 doc/_static/phases.svg | 522 ++ doc/_static/pungi_snake-sm-dark.png | Bin 0 -> 13046 bytes doc/_templates/.keep | 0 doc/about.rst | 70 + doc/comps.rst | 27 + doc/conf.py | 258 + doc/configuration.rst | 2006 +++++++ doc/contributing.rst | 166 + doc/examples.rst | 481 ++ doc/format.rst | 90 + doc/gathering.rst | 102 + doc/index.rst | 25 + doc/messaging.rst | 44 + doc/multi_compose.rst | 107 + doc/phases.rst | 158 + doc/scm_support.rst | 92 + doc/testing.rst | 42 + doc/update-docs.sh | 40 + git-changelog | 105 + pungi.spec | 1761 ++++++ pungi/__init__.py | 33 + pungi/arch.py | 110 + pungi/arch_utils.py | 366 ++ pungi/checks.py | 1358 +++++ pungi/common.py | 34 + pungi/compose.py | 615 +++ pungi/compose_metadata/__init__.py | 0 pungi/compose_metadata/discinfo.py | 93 + pungi/config.py | 79 + pungi/createiso.py | 128 + pungi/dnf_wrapper.py | 155 + pungi/gather.py | 2298 ++++++++ pungi/gather_dnf.py | 1045 ++++ pungi/graph.py | 106 + pungi/ks.py | 223 + pungi/linker.py | 247 + pungi/media_split.py | 127 + pungi/metadata.py | 542 ++ pungi/module_util.py | 71 + pungi/multilib_dnf.py | 67 + pungi/multilib_yum.py | 295 + pungi/notifier.py | 115 + pungi/ostree/__init__.py | 159 + pungi/ostree/base.py | 19 + pungi/ostree/installer.py | 77 + pungi/ostree/tree.py | 154 + pungi/ostree/utils.py | 126 + pungi/pathmatch.py | 73 + pungi/paths.py | 817 +++ pungi/phases/__init__.py | 42 + pungi/phases/base.py | 214 + pungi/phases/buildinstall.py | 928 ++++ pungi/phases/createiso.py | 600 ++ pungi/phases/createrepo.py | 472 ++ pungi/phases/extra_files.py | 141 + pungi/phases/extra_isos.py | 331 ++ pungi/phases/gather/__init__.py | 1093 ++++ pungi/phases/gather/link.py | 167 + pungi/phases/gather/method.py | 28 + pungi/phases/gather/methods/__init__.py | 0 pungi/phases/gather/methods/method_deps.py | 276 + pungi/phases/gather/methods/method_hybrid.py | 561 ++ pungi/phases/gather/methods/method_nodeps.py | 186 + pungi/phases/gather/source.py | 28 + pungi/phases/gather/sources/__init__.py | 0 pungi/phases/gather/sources/source_comps.py | 44 + pungi/phases/gather/sources/source_json.py | 61 + pungi/phases/gather/sources/source_module.py | 54 + pungi/phases/gather/sources/source_none.py | 35 + pungi/phases/image_build.py | 311 ++ pungi/phases/image_checksum.py | 174 + pungi/phases/init.py | 247 + pungi/phases/live_images.py | 406 ++ pungi/phases/livemedia_phase.py | 203 + pungi/phases/osbs.py | 233 + pungi/phases/osbuild.py | 201 + pungi/phases/ostree.py | 207 + pungi/phases/ostree_installer.py | 290 + pungi/phases/phases_metadata.py | 35 + pungi/phases/pkgset/__init__.py | 48 + pungi/phases/pkgset/common.py | 291 + pungi/phases/pkgset/pkgsets.py | 790 +++ pungi/phases/pkgset/source.py | 28 + pungi/phases/pkgset/sources/__init__.py | 0 pungi/phases/pkgset/sources/source_koji.py | 880 +++ pungi/phases/pkgset/sources/source_repos.py | 166 + pungi/phases/repoclosure.py | 137 + pungi/phases/test.py | 121 + pungi/phases/weaver.py | 81 + pungi/profiler.py | 78 + pungi/runroot.py | 375 ++ pungi/scripts/__init__.py | 0 pungi/scripts/comps_filter.py | 113 + pungi/scripts/config_dump.py | 215 + pungi/scripts/config_validate.py | 221 + pungi/scripts/create_unified_isos.py | 35 + pungi/scripts/fedmsg_notification.py | 45 + pungi/scripts/patch_iso.py | 61 + pungi/scripts/pungi.py | 515 ++ pungi/scripts/pungi_gather.py | 226 + pungi/scripts/pungi_koji.py | 638 +++ pungi/scripts/report_progress.py | 23 + .../scripts/wait_for_signed_ostree_handler.py | 110 + pungi/util.py | 1085 ++++ pungi/wrappers/__init__.py | 0 pungi/wrappers/comps.py | 488 ++ pungi/wrappers/createrepo.py | 209 + pungi/wrappers/fus.py | 87 + pungi/wrappers/iso.py | 493 ++ pungi/wrappers/jigdo.py | 68 + pungi/wrappers/kojiwrapper.py | 849 +++ pungi/wrappers/lorax.py | 163 + pungi/wrappers/mbs.py | 43 + pungi/wrappers/pungi.py | 338 ++ pungi/wrappers/repoclosure.py | 83 + pungi/wrappers/scm.py | 476 ++ pungi/wrappers/variants.py | 466 ++ pungi_utils/__init__.py | 0 pungi_utils/config_utils.py | 30 + pungi_utils/orchestrator.py | 706 +++ pungi_utils/patch_iso.py | 140 + pungi_utils/unified_isos.py | 497 ++ requirements.txt | 16 + setup.py | 70 + share/comps-cleanup.xsl | 131 + share/f9-fedora.ks | 192 + share/multilib/devel-blacklist.conf | 9 + share/multilib/devel-whitelist.conf | 2 + share/multilib/runtime-blacklist.conf | 2 + share/multilib/runtime-patterns.conf | 78 + share/multilib/runtime-whitelist.conf | 11 + share/rawhide-fedora.ks | 175 + share/variants.dtd | 54 + test-requirements.txt | 5 + tests/__init__.py | 0 tests/data/client.conf | 10 + tests/data/dummy-comps.xml | 175 + tests/data/dummy-override.json | 7 + tests/data/dummy-pungi.conf | 113 + tests/data/dummy-variants.xml | 111 + tests/data/multi-compose-variants.xml | 47 + tests/data/multi-compose.conf | 22 + tests/data/resilient-storage.conf | 19 + tests/data/server.conf | 12 + tests/data/specs/Dummy-firefox.spec | 44 + tests/data/specs/Dummy-xulrunner.spec | 42 + tests/data/specs/build.sh | 71 + .../specs/dummy-AdobeReader_enu-9.5.1.tar.gz | Bin 0 -> 116 bytes tests/data/specs/dummy-AdobeReader_enu.spec | 37 + tests/data/specs/dummy-atlas.spec | 187 + tests/data/specs/dummy-basesystem.spec | 36 + tests/data/specs/dummy-bash-4.2.37-5.spec | 51 + tests/data/specs/dummy-bash.spec | 66 + tests/data/specs/dummy-elinks.spec | 42 + tests/data/specs/dummy-fcoe-target-utils.spec | 36 + tests/data/specs/dummy-filesystem.spec | 34 + tests/data/specs/dummy-foo32.spec | 42 + tests/data/specs/dummy-freeipa.spec | 41 + tests/data/specs/dummy-gfs2-utils.spec | 43 + tests/data/specs/dummy-glibc.spec | 79 + tests/data/specs/dummy-httpd.spec | 42 + tests/data/specs/dummy-imsettings.spec | 50 + tests/data/specs/dummy-ipw3945-kmod.spec | 54 + tests/data/specs/dummy-kernel.spec | 48 + tests/data/specs/dummy-krb5.spec | 67 + tests/data/specs/dummy-lvm2.spec | 66 + tests/data/specs/dummy-mingw-qt5-qtbase.spec | 47 + tests/data/specs/dummy-perl.spec | 42 + tests/data/specs/dummy-postfix.spec | 45 + .../dummy-release-client-workstation.spec | 36 + tests/data/specs/dummy-release-client.spec | 36 + .../data/specs/dummy-release-notes-cs-CZ.spec | 38 + .../data/specs/dummy-release-notes-en-US.spec | 38 + tests/data/specs/dummy-release-notes.spec | 35 + tests/data/specs/dummy-release-server.spec | 41 + tests/data/specs/dummy-resource-agents.spec | 48 + tests/data/specs/dummy-selinux-policy.spec | 68 + tests/data/specs/dummy-sendmail.spec | 45 + tests/data/specs/dummy-skype.spec | 40 + tests/data/specs/dummy-tftp.spec | 42 + tests/data/specs/dummy-vacation.spec | 43 + tests/fixtures/DP-1.0-20161013.t.4/STATUS | 1 + .../d/dummy-bash-debuginfo-4.2.37-6.i686.rpm | 0 .../i386/debug/tree/repodata/repomd.xml | 0 .../DP-1.0-20161013.t.4-Client-i386-dvd1.iso | 0 .../compose/Client/i386/iso/MD5SUM | 1 + .../compose/Client/i386/iso/SHA1SUM | 1 + .../compose/Client/i386/iso/SHA256SUM | 1 + .../compose/Client/i386/os/.treeinfo | 33 + .../Packages/d/dummy-bash-4.2.37-6.i686.rpm | 0 .../i386/os/repodata/comps-Client.i386.xml | 0 .../Client/i386/os/repodata/repomd.xml | 0 ...DP-1.0-20161013.t.4-Client-source-dvd1.iso | 0 .../compose/Client/source/iso/MD5SUM | 1 + .../compose/Client/source/iso/SHA1SUM | 1 + .../compose/Client/source/iso/SHA256SUM | 1 + .../compose/Client/source/tree/.treeinfo | 33 + .../Packages/d/dummy-bash-4.2.37-6.src.rpm | 0 .../Client/source/tree/repodata/repomd.xml | 0 .../dummy-bash-debuginfo-4.2.37-6.x86_64.rpm | 0 .../x86_64/debug/tree/repodata/repomd.xml | 0 ...DP-1.0-20161013.t.4-Client-x86_64-dvd1.iso | 0 .../compose/Client/x86_64/iso/MD5SUM | 1 + .../compose/Client/x86_64/iso/SHA1SUM | 1 + .../compose/Client/x86_64/iso/SHA256SUM | 1 + .../compose/Client/x86_64/os/.treeinfo | 33 + .../Packages/d/dummy-bash-4.2.37-6.x86_64.rpm | 0 .../os/repodata/comps-Client.x86_64.xml | 0 .../Client/x86_64/os/repodata/repomd.xml | 0 .../d/dummy-elinks-debuginfo-2.6-2.s390x.rpm | 0 .../s390x/debug/tree/repodata/repomd.xml | 0 .../DP-1.0-20161013.t.4-Server-s390x-dvd1.iso | 0 .../compose/Server/s390x/iso/MD5SUM | 1 + .../compose/Server/s390x/iso/SHA1SUM | 1 + .../compose/Server/s390x/iso/SHA256SUM | 1 + .../compose/Server/s390x/os/.treeinfo | 33 + .../d/dummy-filesystem-4.2.37-6.s390x.rpm | 0 .../s390x/os/repodata/comps-Server.s390x.xml | 0 .../Server/s390x/os/repodata/repomd.xml | 0 ...DP-1.0-20161013.t.4-Server-source-dvd1.iso | 0 .../compose/Server/source/iso/MD5SUM | 1 + .../compose/Server/source/iso/SHA1SUM | 1 + .../compose/Server/source/iso/SHA256SUM | 1 + .../compose/Server/source/tree/.treeinfo | 33 + .../d/dummy-filesystem-4.2.37-6.src.rpm | 0 .../Server/source/tree/repodata/repomd.xml | 0 .../d/dummy-elinks-debuginfo-2.6-2.x86_64.rpm | 0 .../x86_64/debug/tree/repodata/repomd.xml | 0 ...DP-1.0-20161013.t.4-Server-x86_64-dvd1.iso | 0 .../compose/Server/x86_64/iso/MD5SUM | 1 + .../compose/Server/x86_64/iso/SHA1SUM | 1 + .../compose/Server/x86_64/iso/SHA256SUM | 1 + .../compose/Server/x86_64/os/.treeinfo | 33 + .../d/dummy-filesystem-4.2.37-6.x86_64.rpm | 0 .../os/repodata/comps-Server.x86_64.xml | 0 .../Server/x86_64/os/repodata/repomd.xml | 0 .../compose/metadata/composeinfo.json | 135 + .../compose/metadata/images.json | 180 + ...config-dump_2016-10-13_09-32-46.global.log | 164 + .../DP-1.0-20161013.t.4/work/.gitignore | 0 .../compose/metadata/composeinfo.json | 25 + .../compose/metadata/images.json | 18 + .../compose/metadata/modules.json | 18 + .../compose/metadata/osbs.json | 4 + .../compose/metadata/rpms.json | 18 + .../compose/metadata/composeinfo.json | 27 + .../compose/metadata/images.json | 20 + .../compose/metadata/modules.json | 20 + .../compose/metadata/osbs.json | 6 + .../compose/metadata/rpms.json | 20 + .../compose/metadata/composeinfo.json | 25 + .../compose/metadata/images.json | 18 + .../compose/metadata/modules.json | 18 + .../basic-metadata/compose/metadata/osbs.json | 4 + .../basic-metadata/compose/metadata/rpms.json | 18 + .../children_task_results_25643870.json | 4856 +++++++++++++++++ tests/fixtures/comps-cleanup-all.xml | 19 + tests/fixtures/comps-cleanup-filter.xml | 43 + tests/fixtures/comps-cleanup-keep.xml | 60 + tests/fixtures/comps-cleanup.xml | 63 + tests/fixtures/comps-env.xml | 106 + .../comps-filtered-environments-variant.xml | 60 + .../fixtures/comps-filtered-environments.xml | 69 + .../comps-filtered-groups-variant.xml | 61 + tests/fixtures/comps-filtered-groups.xml | 71 + .../comps-filtered-packages-variant.xml | 78 + tests/fixtures/comps-filtered-packages.xml | 79 + tests/fixtures/comps-formatted.xml | 129 + tests/fixtures/comps-group.xml | 95 + tests/fixtures/comps-removed-categories.xml | 63 + tests/fixtures/comps-removed-environments.xml | 60 + tests/fixtures/comps-removed-langpacks.xml | 79 + tests/fixtures/comps-removed-translations.xml | 76 + tests/fixtures/comps-typo.xml | 14 + tests/fixtures/comps-ws.xml | 16 + tests/fixtures/comps.xml | 156 + tests/fixtures/comps.xml.in | 82 + .../compose/metadata/composeinfo.json | 25 + .../compose/metadata/images.json | 18 + .../compose/metadata/modules.json | 18 + .../compose/metadata/osbs.json | 4 + .../compose/metadata/rpms.json | 18 + .../compose/metadata/composeinfo.json | 23 + tests/fixtures/expected-treeinfo | 59 + tests/fixtures/extraiso-expected.treeinfo | 58 + tests/fixtures/extraiso.treeinfo | 48 + tests/fixtures/fake-modulemd.yaml | 20 + tests/fixtures/original-treeinfo | 56 + tests/fixtures/prepopulate.json | 18 + ...813277453f7819447ec52ad1e-filelists.xml.gz | Bin 0 -> 338 bytes ...73edabac546c35af84b7bcec85be3-other.xml.gz | Bin 0 -> 435 bytes ...6293e2a1dde8274cf3028dce692-primary.xml.gz | Bin 0 -> 778 bytes .../cockpit-lookaside/repodata/repomd.xml | 28 + ...751a3f47b84031eea266ea585b3-primary.xml.gz | Bin 0 -> 775 bytes ...da33c0022f9d872899705002c-filelists.xml.gz | Bin 0 -> 337 bytes ...965bdffc501b89d9f0c806f6af1af-other.xml.gz | Bin 0 -> 432 bytes .../repos/cockpit/repodata/repomd.xml | 28 + .../repos/debuginfo/repodata/filelists.xml.gz | Bin 0 -> 123 bytes .../repos/debuginfo/repodata/other.xml.gz | Bin 0 -> 123 bytes .../repos/debuginfo/repodata/primary.xml.gz | Bin 0 -> 578 bytes .../repos/debuginfo/repodata/repomd.xml | 28 + ...5cb2f1e5b36e103078637-filelists.sqlite.bz2 | Bin 0 -> 2598 bytes ...64a4354cf199c917c074698-primary.sqlite.bz2 | Bin 0 -> 6090 bytes ...6dcd5715191fbd459d569e83596fc-other.xml.gz | Bin 0 -> 1709 bytes ...252ea5690248c4c4dbeb8c55b-filelists.xml.gz | Bin 0 -> 1632 bytes ...81a2b8568483f6a177dca33a5ab-primary.xml.gz | Bin 0 -> 2801 bytes ...aab7105920d60244000e17446-other.sqlite.bz2 | Bin 0 -> 3055 bytes .../repo-krb5-lookaside/repodata/repomd.xml | 55 + .../repos/repo/repodata/dummy-comps.xml | 175 + .../repos/repo/repodata/dummy-comps.xml.gz | Bin 0 -> 1311 bytes .../repos/repo/repodata/filelists.xml.gz | Bin 0 -> 21107 bytes .../fixtures/repos/repo/repodata/other.xml.gz | Bin 0 -> 21128 bytes .../repos/repo/repodata/primary.xml.gz | Bin 0 -> 34022 bytes tests/fixtures/repos/repo/repodata/repomd.xml | 42 + tests/fixtures/server-rpms.json | 55 + tests/fixtures/tagged-rpms.json | 157 + tests/fixtures/task_children_25643870.json | 445 ++ tests/fixtures/variants.xml | 82 + tests/helpers.py | 327 ++ tests/test_arch.py | 114 + tests/test_arguments.py | 25 + tests/test_buildinstall.py | 2172 ++++++++ tests/test_checks.py | 664 +++ tests/test_compose.py | 755 +++ tests/test_compose.sh | 20 + tests/test_comps_wrapper.py | 217 + tests/test_config.py | 481 ++ tests/test_config_utils.py | 43 + tests/test_config_validate_script.py | 46 + tests/test_createiso_phase.py | 1324 +++++ tests/test_createiso_script.py | 393 ++ tests/test_createrepo_wrapper.py | 161 + tests/test_createrepophase.py | 1368 +++++ tests/test_extra_files_phase.py | 250 + tests/test_extra_isos_phase.py | 1060 ++++ tests/test_fus_wrapper.py | 158 + tests/test_gather.py | 2624 +++++++++ tests/test_gather_method_deps.py | 195 + tests/test_gather_method_hybrid.py | 996 ++++ tests/test_gather_method_nodeps.py | 32 + tests/test_gather_phase.py | 1872 +++++++ tests/test_gather_source_module.py | 77 + tests/test_graph.py | 91 + tests/test_imagebuildphase.py | 1095 ++++ tests/test_imagechecksumphase.py | 259 + tests/test_initphase.py | 680 +++ tests/test_iso_wrapper.py | 214 + tests/test_koji_wrapper.py | 1201 ++++ tests/test_linker.py | 350 ++ tests/test_liveimagesphase.py | 1053 ++++ tests/test_livemediaphase.py | 799 +++ tests/test_lorax_wrapper.py | 96 + tests/test_media_split.py | 129 + tests/test_metadata.py | 221 + tests/test_notifier.py | 149 + tests/test_orchestrator.py | 934 ++++ tests/test_osbs_phase.py | 584 ++ tests/test_osbuild_phase.py | 422 ++ tests/test_ostree_installer_phase.py | 863 +++ tests/test_ostree_phase.py | 790 +++ tests/test_ostree_script.py | 472 ++ tests/test_ostree_utils.py | 49 + tests/test_patch_iso.py | 319 ++ tests/test_pathmatch.py | 64 + tests/test_phase_base.py | 133 + tests/test_pkgset_common.py | 181 + tests/test_pkgset_phase.py | 24 + tests/test_pkgset_pkgsets.py | 963 ++++ tests/test_pkgset_source_koji.py | 948 ++++ tests/test_repoclosure_phase.py | 236 + tests/test_repoclosure_wrapper.py | 152 + tests/test_runroot.py | 234 + tests/test_scm.py | 690 +++ tests/test_test_phase.py | 306 ++ tests/test_unified_isos.py | 797 +++ tests/test_util.py | 1060 ++++ tests/test_variant_wrapper.py | 31 + tox.ini | 63 + 392 files changed, 79408 insertions(+) create mode 100644 .gitignore create mode 100644 AUTHORS create mode 100644 COPYING create mode 100644 GPL create mode 100644 MANIFEST.in create mode 100644 Makefile create mode 100644 README.md create mode 100644 TODO create mode 100644 contrib/yum-dnf-compare/README create mode 100755 contrib/yum-dnf-compare/pungi-compare-depsolving create mode 100755 contrib/yum-dnf-compare/run-dnf.sh create mode 100755 contrib/yum-dnf-compare/run-yum.sh create mode 100644 doc/Makefile create mode 100644 doc/_static/.keep create mode 100644 doc/_static/phases.svg create mode 100644 doc/_static/pungi_snake-sm-dark.png create mode 100644 doc/_templates/.keep create mode 100644 doc/about.rst create mode 100644 doc/comps.rst create mode 100644 doc/conf.py create mode 100644 doc/configuration.rst create mode 100644 doc/contributing.rst create mode 100644 doc/examples.rst create mode 100644 doc/format.rst create mode 100644 doc/gathering.rst create mode 100644 doc/index.rst create mode 100644 doc/messaging.rst create mode 100644 doc/multi_compose.rst create mode 100644 doc/phases.rst create mode 100644 doc/scm_support.rst create mode 100644 doc/testing.rst create mode 100755 doc/update-docs.sh create mode 100755 git-changelog create mode 100644 pungi.spec create mode 100644 pungi/__init__.py create mode 100644 pungi/arch.py create mode 100644 pungi/arch_utils.py create mode 100644 pungi/checks.py create mode 100644 pungi/common.py create mode 100644 pungi/compose.py create mode 100644 pungi/compose_metadata/__init__.py create mode 100644 pungi/compose_metadata/discinfo.py create mode 100644 pungi/config.py create mode 100644 pungi/createiso.py create mode 100644 pungi/dnf_wrapper.py create mode 100644 pungi/gather.py create mode 100644 pungi/gather_dnf.py create mode 100755 pungi/graph.py create mode 100644 pungi/ks.py create mode 100644 pungi/linker.py create mode 100644 pungi/media_split.py create mode 100644 pungi/metadata.py create mode 100644 pungi/module_util.py create mode 100644 pungi/multilib_dnf.py create mode 100755 pungi/multilib_yum.py create mode 100644 pungi/notifier.py create mode 100644 pungi/ostree/__init__.py create mode 100644 pungi/ostree/base.py create mode 100644 pungi/ostree/installer.py create mode 100644 pungi/ostree/tree.py create mode 100644 pungi/ostree/utils.py create mode 100644 pungi/pathmatch.py create mode 100644 pungi/paths.py create mode 100644 pungi/phases/__init__.py create mode 100644 pungi/phases/base.py create mode 100644 pungi/phases/buildinstall.py create mode 100644 pungi/phases/createiso.py create mode 100644 pungi/phases/createrepo.py create mode 100644 pungi/phases/extra_files.py create mode 100644 pungi/phases/extra_isos.py create mode 100644 pungi/phases/gather/__init__.py create mode 100644 pungi/phases/gather/link.py create mode 100644 pungi/phases/gather/method.py create mode 100644 pungi/phases/gather/methods/__init__.py create mode 100644 pungi/phases/gather/methods/method_deps.py create mode 100644 pungi/phases/gather/methods/method_hybrid.py create mode 100644 pungi/phases/gather/methods/method_nodeps.py create mode 100644 pungi/phases/gather/source.py create mode 100644 pungi/phases/gather/sources/__init__.py create mode 100644 pungi/phases/gather/sources/source_comps.py create mode 100644 pungi/phases/gather/sources/source_json.py create mode 100644 pungi/phases/gather/sources/source_module.py create mode 100644 pungi/phases/gather/sources/source_none.py create mode 100644 pungi/phases/image_build.py create mode 100644 pungi/phases/image_checksum.py create mode 100644 pungi/phases/init.py create mode 100644 pungi/phases/live_images.py create mode 100644 pungi/phases/livemedia_phase.py create mode 100644 pungi/phases/osbs.py create mode 100644 pungi/phases/osbuild.py create mode 100644 pungi/phases/ostree.py create mode 100644 pungi/phases/ostree_installer.py create mode 100644 pungi/phases/phases_metadata.py create mode 100644 pungi/phases/pkgset/__init__.py create mode 100644 pungi/phases/pkgset/common.py create mode 100644 pungi/phases/pkgset/pkgsets.py create mode 100644 pungi/phases/pkgset/source.py create mode 100644 pungi/phases/pkgset/sources/__init__.py create mode 100644 pungi/phases/pkgset/sources/source_koji.py create mode 100644 pungi/phases/pkgset/sources/source_repos.py create mode 100644 pungi/phases/repoclosure.py create mode 100644 pungi/phases/test.py create mode 100644 pungi/phases/weaver.py create mode 100644 pungi/profiler.py create mode 100644 pungi/runroot.py create mode 100644 pungi/scripts/__init__.py create mode 100644 pungi/scripts/comps_filter.py create mode 100644 pungi/scripts/config_dump.py create mode 100644 pungi/scripts/config_validate.py create mode 100644 pungi/scripts/create_unified_isos.py create mode 100644 pungi/scripts/fedmsg_notification.py create mode 100644 pungi/scripts/patch_iso.py create mode 100644 pungi/scripts/pungi.py create mode 100644 pungi/scripts/pungi_gather.py create mode 100644 pungi/scripts/pungi_koji.py create mode 100644 pungi/scripts/report_progress.py create mode 100644 pungi/scripts/wait_for_signed_ostree_handler.py create mode 100644 pungi/util.py create mode 100644 pungi/wrappers/__init__.py create mode 100644 pungi/wrappers/comps.py create mode 100644 pungi/wrappers/createrepo.py create mode 100644 pungi/wrappers/fus.py create mode 100644 pungi/wrappers/iso.py create mode 100644 pungi/wrappers/jigdo.py create mode 100644 pungi/wrappers/kojiwrapper.py create mode 100644 pungi/wrappers/lorax.py create mode 100644 pungi/wrappers/mbs.py create mode 100644 pungi/wrappers/pungi.py create mode 100644 pungi/wrappers/repoclosure.py create mode 100644 pungi/wrappers/scm.py create mode 100755 pungi/wrappers/variants.py create mode 100644 pungi_utils/__init__.py create mode 100644 pungi_utils/config_utils.py create mode 100644 pungi_utils/orchestrator.py create mode 100644 pungi_utils/patch_iso.py create mode 100644 pungi_utils/unified_isos.py create mode 100644 requirements.txt create mode 100755 setup.py create mode 100644 share/comps-cleanup.xsl create mode 100644 share/f9-fedora.ks create mode 100644 share/multilib/devel-blacklist.conf create mode 100644 share/multilib/devel-whitelist.conf create mode 100644 share/multilib/runtime-blacklist.conf create mode 100644 share/multilib/runtime-patterns.conf create mode 100644 share/multilib/runtime-whitelist.conf create mode 100644 share/rawhide-fedora.ks create mode 100644 share/variants.dtd create mode 100644 test-requirements.txt create mode 100644 tests/__init__.py create mode 100644 tests/data/client.conf create mode 100644 tests/data/dummy-comps.xml create mode 100644 tests/data/dummy-override.json create mode 100644 tests/data/dummy-pungi.conf create mode 100644 tests/data/dummy-variants.xml create mode 100644 tests/data/multi-compose-variants.xml create mode 100644 tests/data/multi-compose.conf create mode 100644 tests/data/resilient-storage.conf create mode 100644 tests/data/server.conf create mode 100644 tests/data/specs/Dummy-firefox.spec create mode 100644 tests/data/specs/Dummy-xulrunner.spec create mode 100755 tests/data/specs/build.sh create mode 100644 tests/data/specs/dummy-AdobeReader_enu-9.5.1.tar.gz create mode 100644 tests/data/specs/dummy-AdobeReader_enu.spec create mode 100644 tests/data/specs/dummy-atlas.spec create mode 100644 tests/data/specs/dummy-basesystem.spec create mode 100644 tests/data/specs/dummy-bash-4.2.37-5.spec create mode 100644 tests/data/specs/dummy-bash.spec create mode 100644 tests/data/specs/dummy-elinks.spec create mode 100644 tests/data/specs/dummy-fcoe-target-utils.spec create mode 100644 tests/data/specs/dummy-filesystem.spec create mode 100644 tests/data/specs/dummy-foo32.spec create mode 100644 tests/data/specs/dummy-freeipa.spec create mode 100644 tests/data/specs/dummy-gfs2-utils.spec create mode 100644 tests/data/specs/dummy-glibc.spec create mode 100644 tests/data/specs/dummy-httpd.spec create mode 100644 tests/data/specs/dummy-imsettings.spec create mode 100644 tests/data/specs/dummy-ipw3945-kmod.spec create mode 100644 tests/data/specs/dummy-kernel.spec create mode 100644 tests/data/specs/dummy-krb5.spec create mode 100644 tests/data/specs/dummy-lvm2.spec create mode 100644 tests/data/specs/dummy-mingw-qt5-qtbase.spec create mode 100644 tests/data/specs/dummy-perl.spec create mode 100644 tests/data/specs/dummy-postfix.spec create mode 100644 tests/data/specs/dummy-release-client-workstation.spec create mode 100644 tests/data/specs/dummy-release-client.spec create mode 100644 tests/data/specs/dummy-release-notes-cs-CZ.spec create mode 100644 tests/data/specs/dummy-release-notes-en-US.spec create mode 100644 tests/data/specs/dummy-release-notes.spec create mode 100644 tests/data/specs/dummy-release-server.spec create mode 100644 tests/data/specs/dummy-resource-agents.spec create mode 100644 tests/data/specs/dummy-selinux-policy.spec create mode 100644 tests/data/specs/dummy-sendmail.spec create mode 100644 tests/data/specs/dummy-skype.spec create mode 100644 tests/data/specs/dummy-tftp.spec create mode 100644 tests/data/specs/dummy-vacation.spec create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/STATUS create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/i386/debug/tree/Packages/d/dummy-bash-debuginfo-4.2.37-6.i686.rpm create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/i386/debug/tree/repodata/repomd.xml create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/i386/iso/DP-1.0-20161013.t.4-Client-i386-dvd1.iso create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/i386/iso/MD5SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/i386/iso/SHA1SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/i386/iso/SHA256SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/i386/os/.treeinfo create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/i386/os/Packages/d/dummy-bash-4.2.37-6.i686.rpm create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/i386/os/repodata/comps-Client.i386.xml create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/i386/os/repodata/repomd.xml create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/source/iso/DP-1.0-20161013.t.4-Client-source-dvd1.iso create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/source/iso/MD5SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/source/iso/SHA1SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/source/iso/SHA256SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/source/tree/.treeinfo create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/source/tree/Packages/d/dummy-bash-4.2.37-6.src.rpm create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/source/tree/repodata/repomd.xml create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/x86_64/debug/tree/Packages/d/dummy-bash-debuginfo-4.2.37-6.x86_64.rpm create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/x86_64/debug/tree/repodata/repomd.xml create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/x86_64/iso/DP-1.0-20161013.t.4-Client-x86_64-dvd1.iso create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/x86_64/iso/MD5SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/x86_64/iso/SHA1SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/x86_64/iso/SHA256SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/x86_64/os/.treeinfo create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/x86_64/os/Packages/d/dummy-bash-4.2.37-6.x86_64.rpm create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/x86_64/os/repodata/comps-Client.x86_64.xml create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Client/x86_64/os/repodata/repomd.xml create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/s390x/debug/tree/Packages/d/dummy-elinks-debuginfo-2.6-2.s390x.rpm create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/s390x/debug/tree/repodata/repomd.xml create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/s390x/iso/DP-1.0-20161013.t.4-Server-s390x-dvd1.iso create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/s390x/iso/MD5SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/s390x/iso/SHA1SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/s390x/iso/SHA256SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/s390x/os/.treeinfo create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/s390x/os/Packages/d/dummy-filesystem-4.2.37-6.s390x.rpm create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/s390x/os/repodata/comps-Server.s390x.xml create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/s390x/os/repodata/repomd.xml create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/source/iso/DP-1.0-20161013.t.4-Server-source-dvd1.iso create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/source/iso/MD5SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/source/iso/SHA1SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/source/iso/SHA256SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/source/tree/.treeinfo create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/source/tree/Packages/d/dummy-filesystem-4.2.37-6.src.rpm create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/source/tree/repodata/repomd.xml create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/x86_64/debug/tree/Packages/d/dummy-elinks-debuginfo-2.6-2.x86_64.rpm create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/x86_64/debug/tree/repodata/repomd.xml create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/x86_64/iso/DP-1.0-20161013.t.4-Server-x86_64-dvd1.iso create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/x86_64/iso/MD5SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/x86_64/iso/SHA1SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/x86_64/iso/SHA256SUM create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/x86_64/os/.treeinfo create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/x86_64/os/Packages/d/dummy-filesystem-4.2.37-6.x86_64.rpm create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/x86_64/os/repodata/comps-Server.x86_64.xml create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/Server/x86_64/os/repodata/repomd.xml create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/metadata/composeinfo.json create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/compose/metadata/images.json create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/logs/global/config-dump_2016-10-13_09-32-46.global.log create mode 100644 tests/fixtures/DP-1.0-20161013.t.4/work/.gitignore create mode 100644 tests/fixtures/DP-1.0-20181001.n.0/compose/metadata/composeinfo.json create mode 100644 tests/fixtures/DP-1.0-20181001.n.0/compose/metadata/images.json create mode 100644 tests/fixtures/DP-1.0-20181001.n.0/compose/metadata/modules.json create mode 100644 tests/fixtures/DP-1.0-20181001.n.0/compose/metadata/osbs.json create mode 100644 tests/fixtures/DP-1.0-20181001.n.0/compose/metadata/rpms.json create mode 100644 tests/fixtures/basic-metadata-merged/compose/metadata/composeinfo.json create mode 100644 tests/fixtures/basic-metadata-merged/compose/metadata/images.json create mode 100644 tests/fixtures/basic-metadata-merged/compose/metadata/modules.json create mode 100644 tests/fixtures/basic-metadata-merged/compose/metadata/osbs.json create mode 100644 tests/fixtures/basic-metadata-merged/compose/metadata/rpms.json create mode 100644 tests/fixtures/basic-metadata/compose/metadata/composeinfo.json create mode 100644 tests/fixtures/basic-metadata/compose/metadata/images.json create mode 100644 tests/fixtures/basic-metadata/compose/metadata/modules.json create mode 100644 tests/fixtures/basic-metadata/compose/metadata/osbs.json create mode 100644 tests/fixtures/basic-metadata/compose/metadata/rpms.json create mode 100644 tests/fixtures/children_task_results_25643870.json create mode 100644 tests/fixtures/comps-cleanup-all.xml create mode 100644 tests/fixtures/comps-cleanup-filter.xml create mode 100644 tests/fixtures/comps-cleanup-keep.xml create mode 100644 tests/fixtures/comps-cleanup.xml create mode 100644 tests/fixtures/comps-env.xml create mode 100644 tests/fixtures/comps-filtered-environments-variant.xml create mode 100644 tests/fixtures/comps-filtered-environments.xml create mode 100644 tests/fixtures/comps-filtered-groups-variant.xml create mode 100644 tests/fixtures/comps-filtered-groups.xml create mode 100644 tests/fixtures/comps-filtered-packages-variant.xml create mode 100644 tests/fixtures/comps-filtered-packages.xml create mode 100644 tests/fixtures/comps-formatted.xml create mode 100644 tests/fixtures/comps-group.xml create mode 100644 tests/fixtures/comps-removed-categories.xml create mode 100644 tests/fixtures/comps-removed-environments.xml create mode 100644 tests/fixtures/comps-removed-langpacks.xml create mode 100644 tests/fixtures/comps-removed-translations.xml create mode 100644 tests/fixtures/comps-typo.xml create mode 100644 tests/fixtures/comps-ws.xml create mode 100644 tests/fixtures/comps.xml create mode 100644 tests/fixtures/comps.xml.in create mode 100644 tests/fixtures/empty-metadata-merged/compose/metadata/composeinfo.json create mode 100644 tests/fixtures/empty-metadata-merged/compose/metadata/images.json create mode 100644 tests/fixtures/empty-metadata-merged/compose/metadata/modules.json create mode 100644 tests/fixtures/empty-metadata-merged/compose/metadata/osbs.json create mode 100644 tests/fixtures/empty-metadata-merged/compose/metadata/rpms.json create mode 100644 tests/fixtures/empty-metadata/compose/metadata/composeinfo.json create mode 100644 tests/fixtures/expected-treeinfo create mode 100644 tests/fixtures/extraiso-expected.treeinfo create mode 100644 tests/fixtures/extraiso.treeinfo create mode 100644 tests/fixtures/fake-modulemd.yaml create mode 100644 tests/fixtures/original-treeinfo create mode 100644 tests/fixtures/prepopulate.json create mode 100644 tests/fixtures/repos/cockpit-lookaside/repodata/446ee5f2b8296322faf8b19259b26350655f77e813277453f7819447ec52ad1e-filelists.xml.gz create mode 100644 tests/fixtures/repos/cockpit-lookaside/repodata/4f8f323b48f989035622217a41c205b450073edabac546c35af84b7bcec85be3-other.xml.gz create mode 100644 tests/fixtures/repos/cockpit-lookaside/repodata/d07c8273d3954bd3257f6351f3b23fed0e3896293e2a1dde8274cf3028dce692-primary.xml.gz create mode 100644 tests/fixtures/repos/cockpit-lookaside/repodata/repomd.xml create mode 100644 tests/fixtures/repos/cockpit/repodata/54cbdff4c313405103d8b21bf7e66cb1a7eba751a3f47b84031eea266ea585b3-primary.xml.gz create mode 100644 tests/fixtures/repos/cockpit/repodata/ba23b0026102b0510915964775cb2b1679591a4da33c0022f9d872899705002c-filelists.xml.gz create mode 100644 tests/fixtures/repos/cockpit/repodata/e08e47cf6ecc4d6654cc0d462b42a3c6b20965bdffc501b89d9f0c806f6af1af-other.xml.gz create mode 100644 tests/fixtures/repos/cockpit/repodata/repomd.xml create mode 100644 tests/fixtures/repos/debuginfo/repodata/filelists.xml.gz create mode 100644 tests/fixtures/repos/debuginfo/repodata/other.xml.gz create mode 100644 tests/fixtures/repos/debuginfo/repodata/primary.xml.gz create mode 100644 tests/fixtures/repos/debuginfo/repodata/repomd.xml create mode 100644 tests/fixtures/repos/repo-krb5-lookaside/repodata/4fbc657d01000f79cec7b74ada066dfa66fc745a2745cb2f1e5b36e103078637-filelists.sqlite.bz2 create mode 100644 tests/fixtures/repos/repo-krb5-lookaside/repodata/aeb3a17a03cc002051da0120cc3095d105fc74bb764a4354cf199c917c074698-primary.sqlite.bz2 create mode 100644 tests/fixtures/repos/repo-krb5-lookaside/repodata/b9dcd75dda89076e1fdbc4a194d97ce3efc6dcd5715191fbd459d569e83596fc-other.xml.gz create mode 100644 tests/fixtures/repos/repo-krb5-lookaside/repodata/d10e4fa40128e91767cbe4f9fa8d647da70b24e252ea5690248c4c4dbeb8c55b-filelists.xml.gz create mode 100644 tests/fixtures/repos/repo-krb5-lookaside/repodata/e2007d0883d3c7e7b1409b578d6134b55e42a81a2b8568483f6a177dca33a5ab-primary.xml.gz create mode 100644 tests/fixtures/repos/repo-krb5-lookaside/repodata/feada0072a73fd3d224f4ddfb0447c5cfaafa8caab7105920d60244000e17446-other.sqlite.bz2 create mode 100644 tests/fixtures/repos/repo-krb5-lookaside/repodata/repomd.xml create mode 100644 tests/fixtures/repos/repo/repodata/dummy-comps.xml create mode 100644 tests/fixtures/repos/repo/repodata/dummy-comps.xml.gz create mode 100644 tests/fixtures/repos/repo/repodata/filelists.xml.gz create mode 100644 tests/fixtures/repos/repo/repodata/other.xml.gz create mode 100644 tests/fixtures/repos/repo/repodata/primary.xml.gz create mode 100644 tests/fixtures/repos/repo/repodata/repomd.xml create mode 100644 tests/fixtures/server-rpms.json create mode 100644 tests/fixtures/tagged-rpms.json create mode 100644 tests/fixtures/task_children_25643870.json create mode 100644 tests/fixtures/variants.xml create mode 100644 tests/helpers.py create mode 100644 tests/test_arch.py create mode 100644 tests/test_arguments.py create mode 100644 tests/test_buildinstall.py create mode 100644 tests/test_checks.py create mode 100644 tests/test_compose.py create mode 100755 tests/test_compose.sh create mode 100644 tests/test_comps_wrapper.py create mode 100644 tests/test_config.py create mode 100644 tests/test_config_utils.py create mode 100644 tests/test_config_validate_script.py create mode 100644 tests/test_createiso_phase.py create mode 100644 tests/test_createiso_script.py create mode 100644 tests/test_createrepo_wrapper.py create mode 100644 tests/test_createrepophase.py create mode 100644 tests/test_extra_files_phase.py create mode 100644 tests/test_extra_isos_phase.py create mode 100644 tests/test_fus_wrapper.py create mode 100644 tests/test_gather.py create mode 100644 tests/test_gather_method_deps.py create mode 100644 tests/test_gather_method_hybrid.py create mode 100644 tests/test_gather_method_nodeps.py create mode 100644 tests/test_gather_phase.py create mode 100644 tests/test_gather_source_module.py create mode 100644 tests/test_graph.py create mode 100644 tests/test_imagebuildphase.py create mode 100644 tests/test_imagechecksumphase.py create mode 100644 tests/test_initphase.py create mode 100644 tests/test_iso_wrapper.py create mode 100644 tests/test_koji_wrapper.py create mode 100644 tests/test_linker.py create mode 100644 tests/test_liveimagesphase.py create mode 100644 tests/test_livemediaphase.py create mode 100644 tests/test_lorax_wrapper.py create mode 100644 tests/test_media_split.py create mode 100644 tests/test_metadata.py create mode 100644 tests/test_notifier.py create mode 100644 tests/test_orchestrator.py create mode 100644 tests/test_osbs_phase.py create mode 100644 tests/test_osbuild_phase.py create mode 100644 tests/test_ostree_installer_phase.py create mode 100644 tests/test_ostree_phase.py create mode 100644 tests/test_ostree_script.py create mode 100644 tests/test_ostree_utils.py create mode 100644 tests/test_patch_iso.py create mode 100644 tests/test_pathmatch.py create mode 100644 tests/test_phase_base.py create mode 100755 tests/test_pkgset_common.py create mode 100644 tests/test_pkgset_phase.py create mode 100644 tests/test_pkgset_pkgsets.py create mode 100644 tests/test_pkgset_source_koji.py create mode 100644 tests/test_repoclosure_phase.py create mode 100755 tests/test_repoclosure_wrapper.py create mode 100644 tests/test_runroot.py create mode 100644 tests/test_scm.py create mode 100644 tests/test_test_phase.py create mode 100755 tests/test_unified_isos.py create mode 100644 tests/test_util.py create mode 100644 tests/test_variant_wrapper.py create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..07fb4417 --- /dev/null +++ b/.gitignore @@ -0,0 +1,15 @@ +*.py[co] +*~ +*.egg-info +MANIFEST +build/* +dist/* +doc/_build +noarch/* +tests/data/repo +tests/data/repo-krb5-lookaside +tests/_composes +htmlcov/ +.coverage +.idea/ +.tox diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 00000000..d4d1ca99 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,16 @@ +Authors: + +Jesse Keating +Dennis Gilmore +Daniel Mach + +Contributors: + +Will Woods +Essien Ita Essien +James Bowes +Tom Callaway +Joel Andres Granados + +Mark McLoughlin +Jeremy Cline diff --git a/COPYING b/COPYING new file mode 100644 index 00000000..ddba0b83 --- /dev/null +++ b/COPYING @@ -0,0 +1,14 @@ + Pungi - Distribution compose tool + Copyright (C) 2006-2015 Red Hat, Inc. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; version 2 of the License. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, see . diff --git a/GPL b/GPL new file mode 100644 index 00000000..d159169d --- /dev/null +++ b/GPL @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 00000000..90cc4f59 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,15 @@ +include AUTHORS +include COPYING +include GPL +include pungi.spec +include tox.ini +include share/* +include share/multilib/* +include doc/* +include doc/_static/* +include tests/* +include tests/data/* +include tests/data/specs/* +recursive-include tests/fixtures * +global-exclude *.py[co] +global-exclude *~ *.sw? \#*\# diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..be299f9f --- /dev/null +++ b/Makefile @@ -0,0 +1,113 @@ +.PHONY: all clean doc log test + +PKGNAME=pungi +VERSION=$(shell rpm -q --qf "%{VERSION}\n" --specfile ${PKGNAME}.spec | head -n1) +RELEASE=$(shell rpm -q --qf "%{RELEASE}\n" --specfile ${PKGNAME}.spec | head -n1) +GITTAG=${PKGNAME}-$(VERSION) +PKGRPMFLAGS=--define "_topdir ${PWD}" --define "_specdir ${PWD}" --define "_sourcedir ${PWD}/dist" --define "_srcrpmdir ${PWD}" --define "_rpmdir ${PWD}" --define "_builddir ${PWD}" + +RPM="noarch/${PKGNAME}-$(VERSION)-$(RELEASE).noarch.rpm" +SRPM="${PKGNAME}-$(VERSION)-$(RELEASE).src.rpm" + +PYTEST=pytest + + +all: help + + +help: + @echo "Usage: make " + @echo + @echo "Available targets are:" + @echo " help show this text" + @echo " clean remove python bytecode and temp files" + @echo " doc build documentation" + @echo " install install program on current system" + @echo " test run tests" + @echo " test-coverage run tests and generate a coverage report" + @echo " test-compose run a small teest compose (requires test data)" + @echo " test-data build test data (requirement for running tests)" + @echo + @echo "Available rel-eng targets are:" + @echo " archive create source tarball" + @echo " log display changelog for spec file" + @echo " tag create a git tag according to version and release from spec file" + @echo " rpm build rpm" + @echo " srpm build srpm" + @echo " rpminstall build rpm and install it" + @echo " release build srpm and create git tag" + + +tag: + @git tag -a -m "Tag as $(GITTAG)" -f $(GITTAG) + @echo "Tagged as $(GITTAG)" + + +Changelog: + (GIT_DIR=.git git log > .changelog.tmp && mv .changelog.tmp Changelog; rm -f .changelog.tmp) || (touch Changelog; echo 'git directory not found: installing possibly empty changelog.' >&2) + + +log: + @(LC_ALL=C date +"* %a %b %e %Y `git config --get user.name` <`git config --get user.email`> - VERSION"; git log --pretty="format:- %s (%ae)" | sed -r 's/ \(([^@]+)@[^)]+\)/ (\1)/g' | cat) | less + + +archive: + @rm -f Changelog + @rm -f MANIFEST + @make Changelog + @rm -rf ${PKGNAME}-$(VERSION)/ + @python setup.py sdist --formats=bztar > /dev/null + @echo "The archive is in dist/${PKGNAME}-$(VERSION).tar.bz2" + + +srpm: archive + @rm -f $(SRPM) + @rpmbuild -bs ${PKGRPMFLAGS} ${PKGNAME}.spec + @echo "The srpm is in $(SRPM)" + + +rpm: archive + @rpmbuild --clean -bb ${PKGRPMFLAGS} ${PKGNAME}.spec + @echo "The rpm is in $(RPM)" + + +rpminstall: rpm + @rpm -ivh --force $(RPM) + + +release: tag srpm + + +install: + @python setup.py install + + +clean: + @python setup.py clean + @rm -vf *.rpm + @rm -vrf noarch + @rm -vf *.tar.gz + @rm -vrf dist + @rm -vf MANIFEST + @rm -vf Changelog + @find . -\( -name "*.pyc" -o -name '*.pyo' -o -name "*~" -o -name "__pycache__" -\) -delete + @find . -depth -type d -a -name '*.egg-info' -exec rm -rf {} \; + + +test: + $(PYTEST) $(PYTEST_OPTS) + +test-coverage: + $(PYTEST) --cov=pungi --cov-report term --cov-report html --cov-config tox.ini $(PYTEST_OPTS) + +test-data: + ./tests/data/specs/build.sh + +test-compose: + cd tests && ./test_compose.sh + +test-multi-compose: + PYTHONPATH=$$(pwd) PATH=$$(pwd)/bin:$$PATH pungi-orchestrate --debug start tests/data/multi-compose.conf + +doc: + cd doc; make html diff --git a/README.md b/README.md new file mode 100644 index 00000000..5828077b --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# Pungi + +*Pungi* is a distribution compose tool. + +Composes are release snapshots that contain release deliverables such as: + +- installation trees + - RPMs + - repodata + - comps +- (bootable) ISOs +- kickstart trees + - anaconda images + - images for PXE boot + + +## Tool overview + +*Pungi* consists of multiple separate executables backed by a common library. + +The main entry-point is the `pungi-koji` script. It loads the compose +configuration and kicks off the process. Composing itself is done in phases. +Each phase is responsible for generating some artifacts on disk and updating +the `compose` object that is threaded through all the phases. + +*Pungi* itself does not actually do that much. Most of the actual work is +delegated to separate executables. *Pungi* just makes sure that all the +commands are invoked in the appropriate order and with correct arguments. It +also moves the artifacts to correct locations. + + +## Links + +- Documentation: https://docs.pagure.org/pungi/ +- Upstream GIT: https://pagure.io/pungi/ +- Issue tracker: https://pagure.io/pungi/issues +- Questions can be asked on *#fedora-releng* IRC channel on FreeNode diff --git a/TODO b/TODO new file mode 100644 index 00000000..b75bc230 --- /dev/null +++ b/TODO @@ -0,0 +1,75 @@ +Random thoughts on what needs to be done before Pungi 4.0 is completed. + + +Define building blocks and their metadata +========================================= + +* rpms in yum repos +* comps +* kickstart trees +* isos +* kickstart trees +* bootable images +* readme files +* license(s) + + +Compose structure +================= +* topdir + * work, logs, etc. + * compose + * $variant + * $arch + * $content_type (rpms, isos, kickstart trees, etc.) + * actual content + + +Split Pungi into smaller well-defined tools +=========================================== + +* process initial packages + * comps + * json mapping + * ??? + +* grab initial package set + * yum repos + * koji instance (basically what mash does today) + +* resolve deps (gather) + * self-hosting + * fulltree + * multilib + * langpacks + +* create repos + +* create install images + * lorax + * buildinstall + +* create isos + * isos + * bootable + * hybrid + * implant md5sum + * jigdo + * checksums + +* run tests + * just quick sanity tests + +* notification + * email + * messagebus + + +Unsorted +======== +* run any tasks in koji or local host +* support for non-rpm content? (java artifacts, etc.) +* docs! +* unit tests! +* use productmd for metadata: https://github.com/release-engineering/productmd/ +* use next-gen tools: createrepo_c, mergerepo_c, dnf, hawkey, libcomps diff --git a/contrib/yum-dnf-compare/README b/contrib/yum-dnf-compare/README new file mode 100644 index 00000000..eabbf24b --- /dev/null +++ b/contrib/yum-dnf-compare/README @@ -0,0 +1,19 @@ +This directory contains scripts to compare YUM and DNF based gathering code in +Pungi. + +There are two scripts to help re-run the depsolving on existing code. As input +they need .conf and .log file from an existing compose. They collect correct +command line options from them and run the respective tool. + +Run: + + $ run-dnf.sh Server.x86_64.conf + $ run-yum.sh Server.x86_64.conf + +The results are stored in a file with .log.dnf or .log.yum extensions. When +--interactive is used as second argument of the scripts, the output is printed +to terminal (useful for running in debugger). + +To compare the RPM package lists, run: + + $ ./pungi-compare-depsolving Server.x86_64.log.yum Server.x86_64.log.dnf diff --git a/contrib/yum-dnf-compare/pungi-compare-depsolving b/contrib/yum-dnf-compare/pungi-compare-depsolving new file mode 100755 index 00000000..4e63beb5 --- /dev/null +++ b/contrib/yum-dnf-compare/pungi-compare-depsolving @@ -0,0 +1,63 @@ +#!/usr/bin/python + +from __future__ import print_function + + +import argparse +import os +import sys + +here = sys.path[0] +if here != '/usr/bin': + # Git checkout + sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..", ".."))) + +from kobo.rpmlib import parse_nvra, make_nvra +from pungi.wrappers.pungi import PungiWrapper + + +def read_rpms(fn): + pw = PungiWrapper() + with open(fn, "r") as f: + data, _, _ = pw.parse_log(f) + result = set() + for i in data["rpm"]: + nvra = parse_nvra(i["path"]) + result.add(make_nvra(nvra, add_rpm=True)) + + return result + + +parser = argparse.ArgumentParser() +parser.add_argument('old', metavar='OLD', default='pungi-yum.log') +parser.add_argument('new', metavar='NEW', default='pungi-dnf.log') + +args = parser.parse_args() + +yum_rpms = read_rpms(args.old) +dnf_rpms = read_rpms(args.new) + +removed = yum_rpms - dnf_rpms +added = dnf_rpms - yum_rpms + + +print("ADDED: %s" % len(added)) +for i in sorted(added): + print(" %s" % i) + +print() + +print("REMOVED: %s" % len(removed)) +for i in sorted(removed): + print(" %s" % i) + +print() + +print("ADDED: %6s" % len(added)) +print("REMOVED: %6s" % len(removed)) +print("YUM RPMS: %6s" % len(yum_rpms)) +print("DNF RPMS: %6s" % len(dnf_rpms)) +print("ALL RPMS: %6s" % len(yum_rpms | dnf_rpms)) + +if added or removed: + sys.exit(1) diff --git a/contrib/yum-dnf-compare/run-dnf.sh b/contrib/yum-dnf-compare/run-dnf.sh new file mode 100755 index 00000000..326c2e0e --- /dev/null +++ b/contrib/yum-dnf-compare/run-dnf.sh @@ -0,0 +1,24 @@ +#!/bin/bash + +set -e +set -u +set -o pipefail + +HERE=$(dirname "$0") +PATH=$HERE/../../bin:$PATH +PYTHONPATH=$HERE/../../:${PYTHONPATH:-} +export PATH PYTHONPATH + +CONF=$1 +LOG=${CONF%%.conf}.log +ARCH=$(head -n1 "$LOG" | tr ' ' '\n' | grep -- '--arch=') + +CMD=(pungi-gather "--config=$CONF" "$ARCH" $(head -n1 "$LOG" | tr ' ' '\n' | grep '^--\(selfhosting\|fulltree\|greedy\|multilib\)')) + +echo "${CMD[@]}" +if [ $# -le 1 ] || [ "$2" != "--interactive" ]; then + exec >"$LOG.dnf" +fi +exec 2>&1 + +exec "${CMD[@]}" diff --git a/contrib/yum-dnf-compare/run-yum.sh b/contrib/yum-dnf-compare/run-yum.sh new file mode 100755 index 00000000..87efe76d --- /dev/null +++ b/contrib/yum-dnf-compare/run-yum.sh @@ -0,0 +1,28 @@ +#!/bin/sh + +set -e +set -o pipefail +set -u + +export LANG=C + +HERE=$(dirname "$0") +PATH=$HERE/../../bin:$PATH +PYTHONPATH=$HERE/../../ +export PATH PYTHONPATH + +CONF="$1" +LOG=${CONF%%.conf}.log + +tempdir=$(mktemp -d) +trap 'rm -rf $tempdir' EXIT + +cmd=$(head -n1 "$LOG" | cut -d' ' -f2- | sed "s@--\(destdir\|cachedir\)=\(/[^/ ]*\)*@--\1=$tempdir/\1@g" | sed 's/^pungi3/pungi/' | sed "s@--config=/\([^/]*/\)*work/[^/]*/pungi/\([^ ]*\)@--config=$1@g") + +echo "$cmd" +if [ $# -le 1 ] || [ "$2" != "--interactive" ]; then + exec >"$LOG.yum" +fi +exec 2>&1 + +$cmd diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 00000000..58c3f39a --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Pungi.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Pungi.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/Pungi" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Pungi" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/doc/_static/.keep b/doc/_static/.keep new file mode 100644 index 00000000..e69de29b diff --git a/doc/_static/phases.svg b/doc/_static/phases.svg new file mode 100644 index 00000000..5083e3b7 --- /dev/null +++ b/doc/_static/phases.svg @@ -0,0 +1,522 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + Pkgset + + + + Test + + + + Init + + + + + + Buildinstall + + + + Gather + + + + + + ExtraFiles + + + + Createrepo + + + + OSTree + + + + + OSTreeInstaller + + + + + ImageChecksum + + + Createiso + + + + LiveImages + + + + ImageBuild + + + + LiveMedia + + + OSBS + + + ExtraIsos + + + + Repoclosure + + + Repoclosure + + + OSBuild + + + diff --git a/doc/_static/pungi_snake-sm-dark.png b/doc/_static/pungi_snake-sm-dark.png new file mode 100644 index 0000000000000000000000000000000000000000..8ed1425774cfe678d32f76753673ac4ee8695b86 GIT binary patch literal 13046 zcmVOYKWnRc2N7%F+#p2ntA# zjH7^{qP`<8)1U}8bjqN<3W&>)jJORm#o)M%3^>9#jIXc2jM9RLAka%~ompLL*OvPl z`@PSZKhBMeh+4WUtGk)^^Uj=4-HOPF8+Unr_w466kEkk7MPEI3-w-eX+zb3E@N@SZ zJXCwiA3no0HZ`6H#**ze;11w4a2Y5AmA0)6Yv1haeYzx11q2A5r{p^mpvj4oWwZsIPs)| zEZH!P2!KcRF+?5&{vP=9M%I0;c*0r?WbJ10jcjz5$4@J!Kl!TIX3`|`lUz`mzA#=iybe>!4rY-)TH${X?i z&A?XX%PFlyDcRNyr3Q3oV6lo`Sca}Nvbztxv=2e}YEvk2W;WTXo{vjodk z`>rR09-oDJ4534I^g?gez!Xuu{}O?F@8syj|G3$EcsA(CzjsZ^ruvKsK{fjdi}9W3^@jesD1ZRMF`*a1QB8p^Ft{Q*n*J%@D|Yflo}1PSkJoUY;$wCOBU` zc3(em3h3Fuu~vcm?m2kq;{YNi?3<)*CmNd?e-WyGh{!0aP><2sGAvf05hGi>A)m5A zUcXY1J^fI~pfhXA#nsmF^C@KC0D5T^*<4gTy(p}-F>)@2j1C$omsVlEY+U06xqSqk znum&UsBA8-l1oJhzlq34Cr2kPZ(t0bQMw*D6TkyEb3j%7$mFrP`~UeH{=5z}2T%dO z_v>%#afS4606$5&q2yCe&n!U{BST$K%s}KJbf!aA+XlENi|p)0r{<8|eGseasRbb$ zB6|kVvx~4)HL%#BooPJ?sQ?+u!=@rAig5qr z=)`Z|%vd~Kx*j-ZfgKw?m@24O>W%pDkw>O~^rwI9FV7@jMSH*gw%53>)Nc}NQO_-> zNI7InH+uMTOOcBpcZ{G*RirnotkuyAD?;p%gTv^lMFUJgw)dKd672KkYU@J!a>&kJ zsKwwwPcK5bVMapi(X&gfee(%d)glN3#UYd%_FXY!0HJ?@$d68rPAqP8Or8#151b3Y zmW>=p6}H@RlIW!sh!r_F468NtiRIQo zx--a*Ui8Q`IDt(?<0t`Lsllm**1khs$fly=KrgSs^jb^I6*DFR1$1i8j0!Mg;MNf{ z90EZ`3XlrWl`7JkGozsv*}nM{vVRCYvxsczZjf>dh`fGsbmEH}8JDL+*8}I3z{i1s z8#zc5n0nn)TCFobUuJ%`%uFTb&tG-B_n~trrlcFO{h*jZC+AG`G%sdsP<6f{%#~UP zAL>Fj6%>z9Y1mVr36Rl2baECHWNb+F(hAI!gn_)u_8#=iq7XP_q<|iuF~OP*k-hy8 zIHlo5FRj8-#g1{?i0YX|VXf_Y?$~68!(0j3(d+5U0sIQ^E0d!W@y!hQM(D|`wQayB zfEPd60oH-3#jLH?nVl_j;oJ(R=Bs@5d+($k29OR+5vKwq9Y7|8V%i3*7NJX3CGsZb z9=$ARo0z+O1UBc50`0|J@~U#Uh)HV~bf7b?arGCHWbS`$eH(3e9m zt{_8Qs>E(JGj@W3oSk5)0$$N`OK6kR8f_15JqA@F8;V|7SqBC{XV*kF z70k#uHVv~S^wO%xa98Ke%#@%vXHIKx7B&~nbk79HfngKFBZXvVIf&N>$EL=wJATgu zJ?X*kId~|#=is4t1K$PAwST7yaqOv8V^&sb%v?5Lj?Gqh=m(xpv|5MR5|Rtia--w8 zQb@yc%?yE+nsF7Nk6uR0b&*|tDz}Xw+j`K8tF3FyhDb4uo?kYd(w#BmVBY{NRnaqx zB3ru6rvVd*+s!c0S_F;6N?WX$Xv?QexAo_cU405>uFG)2xM-nl*L7?LJ(_GsrU8Xo zbO&C4_htwFM(Bo+zvtkg&j5D;UxYU0UyoT^t1~-Y=G>VjjxN=C^at-IUaG>J-59x4 z%OPx1F#~IDW^#81*6M;+IKN_|%_}s#Dec7hlpVbWcz`OD1Ng=1gqPl}%9-CwN~Y(yBc*>d2>x2x7XbW{&OXpz3l}BpaIenlHgn0X;h1dU(MsPZ!X%+24do-D~)XHHm9$UL5gWp@{vbp)(oJY95R?U zGdLZ!Ccx{rw|SkxUU1pfD=FlOAj=+LEsJ||2&*L53d1{&k{PvN)fmAHLKQU)KVsCyU$CjXyq zC&(XrNs#+WM#2*!?j+()3hva{j-M&t>o_E+8#0|pj2?OWpZ?4>6$0sAcZ&iI}g-TZ+wm%xoi6! z%$Ahps<5R9p=&b$#I~T#?#PA~5ouC7Fta!llHJuycP`D_To(sjI^!gGj!5_%kpSBq zg5$*bLze`15|OjO1>hp87eOy5dQsJ19NqqwYetnPM<>n#ZylQ&e>W-j0Pu^l#krRM6F6x2jv%h29J)|}*~HCB1<3wENCi3IUBJ6$O*$|xIk{lwZ9WY>85{i00JTxZw4HIvBw^GElxhA z=a!L_gMqwpjaR5dXr*qZ@L-o&M9mZK8!!c1YCtX|+|o@?I^@?}iUCO_0ED%uJOYi_cApe;Pt(zz7tQDYQs$E z&_O0p$_>?-lA{sZJ&g@oFtzCr=Rz|Qj?Ex@2kNAQKbjn!_!l<^NsDeCoXH0&h-3j1 zWAkM+5X3q3Tq1IvAa`y;AHGa8BqQ5<(8$B(H8QvKv8R~f|8^mvgq^^+Hh_{>aUl)^ zh;=S%=bkojn!pgFK0-CZ8%P@a=<_btcO2OJbB}b~)71FOi1n{1*R#4%F^g_X5uBJL z4nzr@pa|6lI#X(L3$m*hedv;z{=54;aA0zDV(O*_H=&yfKa5R{zZj7$_1GM?Bh%&_ zF4v%tZtdvR9Jp*twQ0G5MD&0UVwD`-vY|EV108gGys~LOCyptFcPpN`L3NC zMFJO)`uB%V{%S`mesXl;QJlO^_V$U9}jRURbf{?m~rO zJmWO5JVMiUyPkNJ*0GUwJ<|@5xUj`JO)ioa*O=bw6qha$qt1ozK62{)f6{)&$wLod(n6@qXo8X5IpL*YW+RrjM_Q8)3xG$0lkj>pHql3s@n~_ZgG!P3-frWy~ z4YNKQ9=*6~VJEMO*Kfax@m;5lgA@C=>1??GiT)Vsvba_3(IeBMrxrxI)2$J$$L7%W zX36aC(|@LQwrEUKdDFJ(`m1k!o>*XJP+S34VonRLP5-3VxklOmk~Uq{VV1Y_*)JVA z`JR_|+^g_{%)-$OroG3RYmn005#3xb^zB+ z<<{TpBw`$rh_#lFbj8Niuh^?7?*Do8_`8RjhnyUpSVDNeZ0jij$Vfr;;)>|`W%Tf6 z(US}2fDU(&=qHl>(CIZ{x$1ydZ4{IyZH#lgzJ+oY;yH*o66*_j)nKhA3 z1!brU**l=JqZb6~fqSEa-vv;7$H1HUn*fmbDVRfPj%D(`dRT!XTFT==~vk|pzHqLN)=tH=7{|3 zHjGL_Hw@0$)OZ^BaSCat%N5b1)392%lGvdxU5^5ErIEodB^8JiGw6I-^oeCqJw7=) z@gNr7IG0pQB_Np?>v*34f_4IN6+jxdoJ}9$ecei_n|_rIu)S-F!M49i{%+|px$Dsr zzx>kXeNT=~RB`ey+1hPkrfgyWi6Dbrs!uEn(`)GAY0Mw+J5m-V6~ldjAJ_g)^;yH3BwpL372SuY6I^ZsJB<|>k0QXlJDC& z6Ru_bwVUY4-#Z>T@eAMI++%Wd!V~LfwNx`*Grfl7Qc#OJ1ESlyt?2&fj71Gb2bHyY z5wHJr1LM3-8v~~vH}t{^3>Pe*89GZ77t)qiE;U;BUTMHm1sNLxuU}{nqu+Dz&(yhp&Q?pQR2!mY${N&9PgKXpnqg10b^JS<-$SwU=ky4MX z@Zr<~va8p88i1iZbZ6}hf%|XQINtBD?$r1WU^-tT)VD;LU*{NmHBM=?UbWu#zOfEw z6X@o-T9zTu_O3~S+^xqSo~=(6-d!>W3#3#Q!WcUe(gi*yPEGiIVNr!$OItY4p39Sbm|%3{JbgN+PKHB zi^aHgF4{Oq+kGlXjQtS4rlN7o)Eq2V(R0hl-T|vCJ~(Ve;>TtnaHbs70Vu1JqZ8LmE8l(a-+vjn z)Eta!S!M=O)B@(pDFAfYXTq%)i(R~GYsLocqHgxEi5DfN8=R@CO&xEF9_6;bt$fB^B(83pB^XSBO9#t-t!KxTqO{(Dsm#T$+D(dlAeMg|w6XgXqN- z%jqNqhq8YN**~Z{Q&Q$iFjulV@Etu6NSbGhb0$Y8YJgg}X2mSBeFKVD3;snOot(8P z7YBw^_79=+6)S?cfvJl@5WSPD91foV(Z00}Xq$o1VGMNWo=&~v*B#SF2hc4JYWYJ6 z=ji5vUys@@szN>`I#X(u8-u0gL#KF!%Wcykr`KS%+$?a}$P`XsBi5Q~g+T0NwMa<^ zqK~)D*^CuEzbvE!(WQ!Vd9^vc?ERyIq?--)c(G4ZJ^phI_pt{ zgzHqJt73NRQ3}&RSBhkz8haTous#z)1UWF|iDC$x(BF#2lMSIi3$a&V!_(RdHKdpk**^rS0EF%vIlKt(xz35NA==u2X^N;0=d{xhu&w1M z87NPt*P7N_d}Zxhfl{rmC+Csf{Weea;E*TsqL0mqPR=3QyLCMQndl!Xja5uFY=~~W zs8CrUbX#R}(WY&jT|##ESxL}|d1OzYQfdfi7EL~FD%iYCW%#KM4WKHY1*UuGIhug>ZCf88=`iyE{?zSUpppB0ET#ai9`ygmIkb@J4L zT~aMVPt1$#OG=Z^FI$cEP?yJMn{S9V624iI-Yj%yOvb93GF+@62ZsQ$znipJZH_}~ zY-;?uPj&En4jxj_r|4BX3Z2{+6jYsdq@L8Mh8?ctiW7J z@%qCzb`tr0tfA18kR~GO8bJ6qW#9Jx+Ip*5aM%`&Sby~(LU(%TBb}$#K5`*4He>}W zM`oZmD~uFuKthKc7>05~sWgzCiMn;-cy_^Y=KyoO(ydA}*<6IB3i|kh)f3!0g6to% z$xyQ;(S=Hg^2QrE#XScP%>ci2V;7{Yfo{_$*W#M%0z|th-N`}O)G)>Fdp>t@?lXJZ zPWmG0&X|+EP_c-}|vh zTB@VRXHlEdXAy$2L6w0#2*YDj<2Ra1|7~pE%?(nEldd!fI?U~>L|hA`4s%*#R3Mkz zN*q_7tJ?U+#ktSC-cF_ccr2#aq*{cYUJw~62#Xcbiz}w!yqYfFT7c9-T%nu8Kw;6v69%7@Ha|Jjw9^n}-VA2TvYZxHkEY z0dHDy*K%e%xur8wkWCMv>WO`YD6VvSU;ED&=RWh{lneUw@i{ApY8J5MQdYcDZrF6n z_M-i+R8q5mz>Qh0?R3N7B#nALDZROdo?Eu!xs-!}q+3QRFm6(mm6}!Jtk!Jv9+oNt z#QsxBAGIf?dk!A@JK%@8UMB2@s9B?MW!UEmfYw7db}Hx6J`B1Waab;Fh-GCF`>S}{@Ai0yMs+{>;$l9}BRu;Ez;8_UiK|A|7{CL7u8 zE{j5YMQ$Co>4YmaX$JlPWT?xgwx3a76uOGaTQ{8j$&?f}mv9a5EdK9=EgS{_y zh1|9;#J+MaY66sOyCjrD_q>Yl*s|N4&!H~sv6EP3dTJ4Rvu0v%Dxjwqtvb}}$;r_P z{}iXciZ+@${TozQ=*t>wFI6pf^TaZGcpAb0>CYl}Y(nnbWD2r33##@+Ir2Dp$Jp_A zer9ZHeDhPC?CyhyeoK^J!yfHtm7JvLE*!vQaO&mV`O#Rl@nCFR)8rn~H2B5c&*2^Z z7Sf9~n@rrKAW1|PGcaAUsC_o{IC=P{u4yAXPmWGRhF~7JH=<(SuDvb{i z`=zm|@poA@>9y(kqlcb&!L5gG7v#sVhN{mb{g+hF=3XWKsBuY^HXzd3^vLV-*==8% zj!WLeTbAf#!; zmI0hETbf{7kLjQ$_2#TO-SHVyLYdH-4^7UB3>Tn3Z^lABu9Hi7luJ1I7{aH3N3J(> z`X7(K`Ce81Rp2>v&O5wO^1#;|y#4tH5B)>)!(*rZ)f;i)p}?gJ&Sm(+kA9wy{qg7d zH~;RPY`T4?e|+w^yQ8~@z@>36L*OzvNfWpXf3%RdjqFGXPp3Zq4gcuQnY<-y16w=9qO{D zu8=|c^AUa75D|~}7f?4RfdVCg zORDYP>&Xtyvh7-f!Btpnfj!rbLaa~VJH$UxgYW#bN{D0JA zGX)|KBL$UBMWGSf^gQRlB@=eQ#9g^z%}|fbwBk>Jv(8Y5r!A6uOP_rwVjY~ap(XOV zGfE-tEElHJp#MPN{s#C8@Nlyy=a-JXWhB&iNCNut^f{5U&p&YJx(d0i-KCI3Q}4h3 z+w=d|zj*mXtu8Z`G-}0?t{N!H3#P2GRj?>#+40h?A0uv1BH4)0hyD z+eV<;fPC6wcS}{9nSI&%+>lRMtH_12O#r^I3l4da zdCukzAOLGJcWR;4nsKCnqyx)yY$+mxdCMRM4m~;}>l~F&S+CB^Yc>bwOyV;XGsrD{ z=wowGk1VIMxtQdYq^bX^q=P!CAT607t4>tB)S6BY%;RRR7WWMdoZ~e=6=K6>BhFyH*!=L9vANVw{`Mz)Ew|?(!C}}=_ z=_t?bPLm0*7IWt{iZ{9ZUAu=~eN&d^(*h>}s2i_G^oiwdvZaVl%}YlwncXTvp0NM` z5@$(7K~#MT+q*52P_CmFSB14YvTs1O9t+L>n}W&gK&($rwJlq`wHxWr zDI!86Ugty^8-m4(aU7UZ-r9}UBIU%qkPcu^zh!wEu|?F288j2(%XR#GY0cN;w68^J zEj0)?7kzq5x1{DP@}^t1@X|((&;8{QzWwFTVbkW3b&h$oF-N{O$L1h^m6&rbQ+AU2 z=`Dlz{^3T)_GyCyFg7*5AFp3SwM)+~*+9CaQl~eAbZ3p5vLRF>B@mm1(B7K38H!K( zd&-`E%a^3X7S{lDrI5XYO5_Fat+7xug^>=C1A}mG*+NPA(Dc?VeaLDZ&83w_B%E46 zcl08e5FbbCPb`S{pk9fWs~XLh5TN+F+l0p#to-=)5neRc;HS53r#qFyxeT?c^8R1? z1TXxSJNUNmc@dK3E-7YacjI=u#$SJzwL>+x9w#;Plog|f)5zE+!KRY(W8u_2qY zS!o#f&GX$hVm{ZgY0g`icI+DAi~sPusHAwXe44v7CL3HW=A26(7lJoz8NBy~ z#N0CmP6E(dQGScqJ3Y5#jknW*afCHUZJjuo?WSj!?B=)k*j!4mv_pG);mt+s_3W$+ zc%6#`%jKgcI=6IN*krBN0<<0>TYHdV23@HreL4KuCDD-r{^&IEd>P-9C7Lg5baYyx zYJ;v`Gddb&b#*V!f&~~P0TIO-SwkL-uwICRB#f2_MmzQk(V=HR=uzyGE%VSr$<_CR@Qsv%$2Q`*J8zL z!9*+!@_5p6IB;fO=TkQS^!RLtP9qTH&do^OqbKI9T_nJ87cyM1O8?$G98b*m;XK-x z$1hjaKYU3Vr8+(n(s*J?qs6imU%rp*Z6mNyL590bY&Hk$_D$B2Hz~1w!QK(x*1w7F zFqZ(3=97Q=Wqj;-!;gIDe64c&>xg{kb;R7qK;FD%@ZRg@d7g1_nlv^w{(4k@53l{q zmO?faP5e|Erl<#UNv|Bx6LX!RpuQZky+`%*g2?WE1Md6^^ygHzcB98;EPUj|YPB`d zXS3y&F_8FAR2z^9(bJ3Qat-$Oq32ief=1=KL^EqdkIxgGTc+@Xcaq&R0B0AidUNkU z#{(sM2a^75mG$c!+1{rQWO`*REKn-N+S>kGgxHm_1c2QNJ_?@HTdNNRIpsRH# z+qLP@ndTguWY%=X9)?V4^Cq20P>%SKD8=`VY~iCHeh}}4pSl0F>xO}9^ml9JGb7HW z_gzEGRh^{XzGd*<&U%Gs8=NMMO^x4)>ZgGnlo~aiFK1b#%`6Q-VuL2e08S+)x*BxuJxC__GUmam4c_ z4YzjtaC>hc<%adSnOQ@c?TZ6vKr~CI1F_lDmsW*x(iQ8r5i=TQO1$8X?eYDY{-`U+ zW}4h_{OBc)JbI2d{J<+ORU2m?LAbXG+IxTD<9zKOPwtZ{auKj1iKQwG=55fe#MO$#r%R@fvY}0LT&!B-*6lqo zU&5lm0(<&#sQ_Il!AQ}}XjNoaA6!^QT@d^3v?ubRsy4#joYTb$Tv`q3%^`(!i-U){ zkiMMi)ZBVtRrVP7tvA5~dr($u7D^o{th_BOzVzE&_QTF)UgTVw?|$X4GBtUDKlqb> z$t%9|MRBb*`{{bLbgy%n{HtF2E1W$u!+-niuW{F1V>p*Nk%+m6pHXnerpCpW>wAd& zOAy&2PKFQ}1dY{e3EQeTIfio&xqRvzPF_i@KZNjVoLEx67Tc3pO6*(`e+X>z6cv3VhQOIh|T3{-c+5n4Q zWJBZVCJ?*(t?BqoTVuR^1NLC#(;ne1lcN(KdGNvahQm8Eza}p8z$ZWckMeh4nB>+iNR{)be@p}S4V+s8?U&fU5RvCoi5far?k0*Yy)j!d zJ(8@YqZe0O?UQ%(Ad2-FXacdT53M#jyB6;1Yc81d5F*cOPjehO^{-y-T<}MM%M3Kd zT&1LZMtQm9Qv+IQAk_#>IV2OBBCRxR z&Q3nnnz0;vn~r#S)glF3yUmZOMV6$?g=jS@(UUzVh4hRz^ru{Z_9U z$7fqfx@u(Q#fPV%kQOOqtg@)#Mf$Q31Q3cnU@KMCrK$nel}0ufYdBthEnood*!y$m zAAIn=FB{qw|BA-(yI%O>J@S<=Px8EbZXu2OF%ou1|g(ApZo6tw6TdPzxKWnzc?8~X_>|Mdh%O*!BZm59c z*qPtB7YYAkAeq5+E?G}Aq^4KOC%*ywlfY#@?Of)KSAjG7(A(dFllLJqAcE*()wm-Y zT5e^o)Jh3-rC~=89G`6+AaoXa9`YT zJwuybx+*d{WDS2Vt{O<8Lr=_^Pg9A^!pkIUrYS=Z2;we=9rFC)VRB@?2{ zRgrwk42@=v$rkWaJvP(gu3QS)({CNJ`g2}(^e*G%C6l8Q8!FzIeBuLJ8WA54UFO?b zVr*TUd9Ts_9mB6Z0d3aW=;8Z!17DYP(5Lkn5wYGiih)zAw`6qN1+$|E+Cm)bOX%foo@>X7iv2mHKaVa}yln4T#L2hZ zY=hN5EoNYA5lM%g&SaBj)=boFDZ)S(oLw@rwvaZlSZ=_k zf>4V)*IE;ST*{_DrvfNsWPJg?fxH2;P_}OGmsXqH+u4$A=pPzXZJbTHl3a!#j9v z7WNL<+L%!yp96-=kVl}$y_T4Y>S%s?@tdURTvvz=vYk8;N* ztGvynEH%-H?Rp0CrXxoR$mU{%a2|N;ZE-SPZ)dLoFk40gOqBIyA(b;jqzR5B z-gv`XC}(G%s#`W45;$uDdwv<_%Cf$2cz?|nL^`u5>#6Koj9y+9>CRZ6fI=E>9kysj zrO{lX(i6BE!h3-a{jXXIIaIH8is`JRgH~c`q+n6uCd;P->+!NuGX>d~wI|XEN#O9w z&k~3&R@9st(oQEA;MQRzpSCAoK>rI(l@*BGe+LBiHKdwFa`Qj|51I<2gaL^;psmAaI{T_}OP-v52QbA*%nc?CSe| zy`t-0hlr}jHn3ZY_C<45jBVYWYp-341lZMw#%k?G+81pF(;rCyQg-y9g|sbKxm>l_ z*Vdx-tBzFk_)M#qquf9rpSQpxpif*em2@CyM$1Ck6nryi8YXFg`Ldbr{rM_=IR!ln z{2}n^$+3yYHa3jU4vDHV`tZ-5SJkajZotJAv%-oQXy!@^X^TglU$*rMnzXgsbj0QB za844&C-!h|+05FIo3#TbcW1Bm z`imKRlIP1E;dKU+){>_eEwYdckw((Q`-!C%M>$(r7blixZU#@AP3FM7`I(Z5sn8*z zi^v2qy}4GKVAVC0M{x2L;2T&}d-9vHbn!Dm*9?4)9(l(;BL7j+!9C(Nt>uOzlXM^y zkW_%iipvCM)veVHz*JyMX2l*BsvSuwoPezhZNN6Xfh5@MumM{WKv!#MHM;C}_VyFF z^i>xJBuxY^p`1pzjL1ctT*4NbUB=Q0ho8yC?fzHLQ|5C-Y9p5Q z4Fl1ndY%1x3DAMw@3 z&p-ace{+pk&;MSuv1Hq$_wPjYmr;GWDua>^vJyC}@NC2uh4vmYDHB1VvjAe#!7J5~ zo~&^ef`rbaTGvK=9Or&y>W&ZH)bzanztYp0pCcOk+i3W=0QX8D!|FA_t4J=Du?dz* z=12sM;<`5ciUd+tuTP+SO1=N%$M62Vs}{NYKV Tool*. That name was quickly discarded and replaced +with Pungi. + +There was also a bit of an inside joke that when said aloud, it could sound +like punji, which is `a sharpened stick at the bottom of a +trap `_. Kind of like software… diff --git a/doc/comps.rst b/doc/comps.rst new file mode 100644 index 00000000..6f13686c --- /dev/null +++ b/doc/comps.rst @@ -0,0 +1,27 @@ +.. _comps: + +Processing comps files +====================== + +The comps file that Pungi takes as input is not really pure comps as used by +tools like DNF. There are extensions used to customize how the file is processed. + +The first step of Pungi processing is to retrieve the actual file. This can use +anything that :ref:`scm_support` supports. + +Pungi extensions are ``arch`` attribute on ``packageref``, ``group`` and +``environment`` tags. The value of this attribute is a comma separated list of +architectures. + +Second step Pungi performs is creating a file for each architecture. This is +done by removing all elements with incompatible ``arch`` attribute. No +additional clean up is performed on this file. The resulting file is only used +internally for the rest of the compose process. + +Third and final step is to create comps file for each Variant.Arch combination. +This is the actual file that will be included in the compose. The start file is +the original input file, from which all elements with incompatible architecture +are removed. Then clean up is performed by removing all empty groups, removing +non-existing groups from environments and categories and finally removing empty +environments and categories. As a last step groups not listed in the variants +file are removed. diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 00000000..6aa7e512 --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,258 @@ +# -*- coding: utf-8 -*- +# +# Pungi documentation build configuration file, created by +# sphinx-quickstart on Thu Jul 2 08:11:04 2015. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Pungi' +copyright = u'2016, Red Hat, Inc.' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '4.2' +# The full version, including alpha/beta/rc tags. +release = '4.2.7' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Pungidoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'Pungi.tex', u'Pungi Documentation', + u'Daniel Mach', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'pungi', u'Pungi Documentation', + [u'Daniel Mach'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'Pungi', u'Pungi Documentation', + u'Daniel Mach', 'Pungi', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/doc/configuration.rst b/doc/configuration.rst new file mode 100644 index 00000000..d4abb0d6 --- /dev/null +++ b/doc/configuration.rst @@ -0,0 +1,2006 @@ +=============== + Configuration +=============== + +Please read +`productmd documentation `_ +for +`terminology `_ +and other release and compose related details. + + +Minimal Config Example +====================== +:: + + # RELEASE + release_name = "Fedora" + release_short = "Fedora" + release_version = "23" + + # GENERAL SETTINGS + comps_file = "comps-f23.xml" + variants_file = "variants-f23.xml" + + # KOJI + koji_profile = "koji" + runroot = False + + # PKGSET + sigkeys = [None] + pkgset_source = "koji" + pkgset_koji_tag = "f23" + + # CREATEREPO + createrepo_checksum = "sha256" + + # GATHER + gather_method = "deps" + greedy_method = "build" + check_deps = False + + # BUILDINSTALL + buildinstall_method = "lorax" + + +Release +======= +Following **mandatory** options describe a release. + + +Options +------- + +**release_name** [mandatory] + (*str*) -- release name + +**release_short** [mandatory] + (*str*) -- release short name, without spaces and special characters + +**release_version** [mandatory] + (*str*) -- release version + +**release_type** = "ga" (*str*) -- release type, for example ``ga``, + ``updates`` or ``updates-testing``. See `list of all valid values + `_ + in productmd documentation. + +**release_internal** = False + (*bool*) -- whether the compose is meant for public consumption + +**treeinfo_version** + (*str*) Version to display in ``.treeinfo`` files. If not configured, the + value from ``release_version`` will be used. + + +Example +------- +:: + + release_name = "Fedora" + release_short = "Fedora" + release_version = "23" + # release_type = "ga" + + +Base Product +============ +Base product options are **optional** and we need +to them only if we're composing a layered product +built on another (base) product. + + +Options +------- + +**base_product_name** + (*str*) -- base product name + +**base_product_short** + (*str*) -- base product short name, without spaces and special characters + +**base_product_version** + (*str*) -- base product **major** version + +**base_product_type** = "ga" + (*str*) -- base product type, "ga", "updates" etc., for full list see + documentation of *productmd*. + + +Example +------- +:: + + release_name = "RPM Fusion" + release_short = "rf" + release_version = "23.0" + + base_product_name = "Fedora" + base_product_short = "Fedora" + base_product_version = "23" + +General Settings +================ + +Options +------- + +**comps_file** [mandatory] + (:ref:`scm_dict `, *str* or None) -- reference to comps XML + file with installation groups + +**variants_file** [mandatory] + (:ref:`scm_dict ` or *str*) -- reference to variants XML file + that defines release variants and architectures + +**module_defaults_dir** [optional] + (:ref:`scm_dict ` or *str*) -- reference the module defaults + directory containing modulemd-defaults YAML documents. Files relevant for + modules included in the compose will be embedded in the generated repodata + and available for DNF. + + :: + + module_defaults_dir = { + "scm": "git", + "repo": "https://pagure.io/releng/fedora-module-defaults.git", + "dir": ".", + } + +**failable_deliverables** [optional] + (*list*) -- list which deliverables on which variant and architecture can + fail and not abort the whole compose. This only applies to ``buildinstall`` + and ``iso`` parts. All other artifacts can be configured in their + respective part of configuration. + + Please note that ``*`` as a wildcard matches all architectures but ``src``. + +**comps_filter_environments** [optional] + (*bool*) -- When set to ``False``, the comps files for variants will not + have their environments filtered to match the variant. + +**tree_arches** + ([*str*]) -- list of architectures which should be included; if undefined, + all architectures from variants.xml will be included + +**tree_variants** + ([*str*]) -- list of variants which should be included; if undefined, all + variants from variants.xml will be included + +**repoclosure_strictness** + (*list*) -- variant/arch mapping describing how repoclosure should run. + Possible values are + + * ``off`` -- do not run repoclosure + * ``lenient`` -- (default) run repoclosure and write results to logs, but + detected errors are only reported in logs + * ``fatal`` -- abort compose when any issue is detected + + When multiple blocks in the mapping match a variant/arch combination, the + last value will win. + +**repoclosure_backend** + (*str*) -- Select which tool should be used to run repoclosure over created + repositories. By default ``yum`` is used, but you can switch to ``dnf``. + Please note that when ``dnf`` is used, the build dependencies check is + skipped. On Python 3, only ``dnf`` backend is available. + +**cts_url** + (*str*) -- URL to Compose Tracking Service. If defined, Pungi will add + the compose to Compose Tracking Service and ge the compose ID from it. + For example ``https://cts.localhost.tld/`` + +**cts_keytab** + (*str*) -- Path to Kerberos keytab which will be used for Compose + Tracking Service Kerberos authentication. If not defined, the default + Kerberos principal is used. + +**compose_type** + (*str*) -- Allows to set default compose type. Type set via a command-line + option overwrites this. + +**mbs_api_url** + (*str*) -- URL to Module Build Service (MBS) API. + For example ``https://mbs.example.com/module-build-service/2``. + This is required by ``pkgset_scratch_modules``. + +Example +------- +:: + + comps_file = { + "scm": "git", + "repo": "https://git.fedorahosted.org/git/comps.git", + "branch": None, + "file": "comps-f23.xml.in", + } + + variants_file = { + "scm": "git", + "repo": "https://pagure.io/pungi-fedora.git ", + "branch": None, + "file": "variants-fedora.xml", + } + + failable_deliverables = [ + ('^.*$', { + # Buildinstall can fail on any variant and any arch + '*': ['buildinstall'], + 'src': ['buildinstall'], + # Nothing on i386 blocks the compose + 'i386': ['buildinstall', 'iso', 'live'], + }) + ] + + tree_arches = ["x86_64"] + tree_variants = ["Server"] + + repoclosure_strictness = [ + # Make repoclosure failures fatal for compose on all variants … + ('^.*$', {'*': 'fatal'}), + # … except for Everything where it should not run at all. + ('^Everything$', {'*': 'off'}) + ] + + +Image Naming +============ + +Both image name and volume id are generated based on the configuration. Since +the volume id is limited to 32 characters, there are more settings available. +The process for generating volume id is to get a list of possible formats and +try them sequentially until one fits in the length limit. If substitutions are +configured, each attempted volume id will be modified by it. + +For layered products, the candidate formats are first +``image_volid_layered_product_formats`` followed by ``image_volid_formats``. +Otherwise, only ``image_volid_formats`` are tried. + +If no format matches the length limit, an error will be reported and compose +aborted. + +Options +------- + +There a couple common format specifiers available for both the options: + * ``compose_id`` + * ``release_short`` + * ``version`` + * ``date`` + * ``respin`` + * ``type`` + * ``type_suffix`` + * ``label`` + * ``label_major_version`` + * ``variant`` + * ``arch`` + * ``disc_type`` + +**image_name_format** [optional] + (*str|dict*) -- Python's format string to serve as template for image + names. The value can also be a dict mapping variant UID regexes to the + format string. The pattern should not overlap, otherwise it is undefined + which one will be used. + + This format will be used for all phases generating images. Currently that + means ``createiso``, ``live_images`` and ``buildinstall``. + + Available extra keys are: + * ``disc_num`` + * ``suffix`` + +**image_volid_formats** [optional] + (*list*) -- A list of format strings for generating volume id. + + The extra available keys are: + * ``base_product_short`` + * ``base_product_version`` + +**image_volid_layered_product_formats** [optional] + (*list*) -- A list of format strings for generating volume id for layered + products. The keys available are the same as for ``image_volid_formats``. + +**restricted_volid** = False + (*bool*) -- New versions of lorax replace all non-alphanumerical characters + with dashes (underscores are preserved). This option will mimic similar + behaviour in Pungi. + +**volume_id_substitutions** [optional] + (*dict*) -- A mapping of string replacements to shorten the volume id. + +**disc_types** [optional] + (*dict*) -- A mapping for customizing ``disc_type`` used in image names. + + Available keys are: + * ``boot`` -- for ``boot.iso`` images created in *buildinstall* phase + * ``live`` -- for images created by *live_images* phase + * ``dvd`` -- for images created by *createiso* phase + * ``ostree`` -- for ostree installer images + + Default values are the same as the keys. + +Example +------- +:: + + # Image name respecting Fedora's image naming policy + image_name_format = "%(release_short)s-%(variant)s-%(disc_type)s-%(arch)s-%(version)s%(suffix)s" + # Use the same format for volume id + image_volid_formats = [ + "%(release_short)s-%(variant)s-%(disc_type)s-%(arch)s-%(version)s" + ] + # No special handling for layered products, use same format as for regular images + image_volid_layered_product_formats = [] + # Replace "Cloud" with "C" in volume id etc. + volume_id_substitutions = { + 'Cloud': 'C', + 'Alpha': 'A', + 'Beta': 'B', + 'TC': 'T', + } + + disc_types = { + 'boot': 'netinst', + 'live': 'Live', + 'dvd': 'DVD', + } + + +Signing +======= + +If you want to sign deliverables generated during pungi run like RPM wrapped +images. You must provide few configuration options: + +**signing_command** [optional] + (*str*) -- Command that will be run with a koji build as a single + argument. This command must not require any user interaction. + If you need to pass a password for a signing key to the command, + do this via command line option of the command and use string + formatting syntax ``%(signing_key_password)s``. + (See **signing_key_password_file**). + +**signing_key_id** [optional] + (*str*) -- ID of the key that will be used for the signing. + This ID will be used when crafting koji paths to signed files + (``kojipkgs.fedoraproject.org/packages/NAME/VER/REL/data/signed/KEYID/..``). + +**signing_key_password_file** [optional] + (*str*) -- Path to a file with password that will be formatted + into **signing_command** string via ``%(signing_key_password)s`` + string format syntax (if used). + Because pungi config is usually stored in git and is part of compose + logs we don't want password to be included directly in the config. + Note: If ``-`` string is used instead of a filename, then you will be asked + for the password interactivelly right after pungi starts. + +Example +------- +:: + + signing_command = '~/git/releng/scripts/sigulsign_unsigned.py -vv --password=%(signing_key_password)s fedora-24' + signing_key_id = '81b46521' + signing_key_password_file = '~/password_for_fedora-24_key' + + +.. _git-urls: + +Git URLs +======== + +In multiple places the config requires URL of a Git repository to download some +file from. This URL is passed on to *Koji*. It is possible to specify which +commit to use using this syntax: :: + + git://git.example.com/git/repo-name.git?# + +The ```` pattern can be replaced with actual commit SHA, a tag name, +``HEAD`` to indicate that tip of default branch should be used or +``origin/`` to use tip of arbitrary branch. + +If the URL specifies a branch or ``HEAD``, *Pungi* will replace it with the +actual commit SHA. This will later show up in *Koji* tasks and help with +tracing what particular inputs were used. + +.. note:: + + The ``origin`` must be specified because of the way *Koji* works with the + repository. It will clone the repository then switch to requested state + with ``git reset --hard REF``. Since no local branches are created, we need + to use full specification including the name of the remote. + + + +Createrepo Settings +=================== + + +Options +------- + +**createrepo_checksum** + (*str*) -- specify checksum type for createrepo; expected values: + ``sha512``, ``sha256``, ``sha1``. Defaults to ``sha256``. + +**createrepo_c** = True + (*bool*) -- use createrepo_c (True) or legacy createrepo (False) + +**createrepo_deltas** = False + (*list*) -- generate delta RPMs against an older compose. This needs to be + used together with ``--old-composes`` command line argument. The value + should be a mapping of variants and architectures that should enable + creating delta RPMs. Source and debuginfo repos never have deltas. + +**createrepo_use_xz** = False + (*bool*) -- whether to pass ``--xz`` to the createrepo command. This will + cause the SQLite databases to be compressed with xz. + +**createrepo_num_threads** + (*int*) -- how many concurrent ``createrepo`` process to run. The default + is to use one thread per CPU available on the machine. + +**createrepo_num_workers** + (*int*) -- how many concurrent ``createrepo`` workers to run. Value defaults to 3. + +**createrepo_database** + (*bool*) -- whether to create SQLite database as part of the repodata. This + is only useful as an optimization for clients using Yum to consume to the + repo. Default value depends on gather backend. For DNF it's turned off, for + Yum the default is ``True``. + +**createrepo_extra_args** + (*[str]*) -- a list of extra arguments passed on to ``createrepo`` or + ``createrepo_c`` executable. This could be useful for enabling zchunk + generation and pointing it to correct dictionaries. + +**createrepo_extra_modulemd** + (*dict*) -- a mapping of variant UID to :ref:`an scm dict `. + If specified, it should point to a directory with extra module metadata + YAML files that will be added to the repository for this variant. The + cloned files should be split into subdirectories for each architecture of + the variant. + +**product_id** = None + (:ref:`scm_dict `) -- If specified, it should point to a + directory with certificates ``*--*.pem``. Pungi will + copy each certificate file into the relevant Yum repositories as a + ``productid`` file in the ``repodata`` directories. The purpose of these + ``productid`` files is to expose the product data to `subscription-manager + `_. + subscription-manager includes a "product-id" Yum plugin that can read these + ``productid`` certificate files from each Yum repository. + +**product_id_allow_missing** = False + (*bool*) -- When ``product_id`` is used and a certificate for some variant + and architecture is missing, Pungi will exit with an error by default. + When you set this option to ``True``, Pungi will ignore the missing + certificate and simply log a warning message. + +**product_id_allow_name_prefix** = True + (*bool*) -- Allow arbitrary prefix for the certificate file name (see + leading ``*`` in the pattern above). Setting this option to ``False`` will + make the pattern more strict by requiring the file name to start directly + with variant name. + + +Example +------- +:: + + createrepo_checksum = "sha" + createrepo_deltas = [ + # All arches for Everything should have deltas. + ('^Everything$', {'*': True}), + # Also Server.x86_64 should have them (but not on other arches). + ('^Server$', {'x86_64': True}), + ] + createrepo_extra_modulemd = { + "Server": { + "scm": "git", + "repo": "https://example.com/extra-server-modulemd.git", + "dir": ".", + # The directory should have this layout. Each architecture for the + # variant should be included (even if the directory is empty. + # . + # ├── aarch64 + # │ ├── some-file.yaml + # │ └ ... + # └── x86_64 + } + } + + +Package Set Settings +==================== + + +Options +------- + +**sigkeys** + ([*str* or None]) -- priority list of signing key IDs. These key IDs match + the key IDs for the builds in Koji. Pungi will choose signed packages + according to the order of the key IDs that you specify here. Use one + single key in this list to ensure that all RPMs are signed by one key. If + the list includes an empty string or *None*, Pungi will allow unsigned + packages. If the list only includes *None*, Pungi will use all unsigned + packages. + +**pkgset_source** [mandatory] + (*str*) -- "koji" (any koji instance) or "repos" (arbitrary yum repositories) + +**pkgset_koji_tag** + (*str|[str]*) -- tag(s) to read package set from. This option can be + omitted for modular composes. + +**pkgset_koji_builds** + (*str|[str]*) -- extra build(s) to include in a package set defined as NVRs. + +**pkgset_koji_scratch_tasks** + (*str|[str]*) -- RPM scratch build task(s) to include in a package set, + defined as task IDs. This option can be used only when ``compose_type`` + is set to ``test``. The RPM still needs to have higher NVR than any + other RPM with the same name coming from other sources in order to + appear in the resulting compose. + +**pkgset_koji_module_tag** + (*str|[str]*) -- tags to read module from. This option works similarly to + listing tags in variants XML. If tags are specified and variants XML + specifies some modules via NSVC (or part of), only modules matching that + list will be used (and taken from the tag). Inheritance is used + automatically. + +**pkgset_koji_module_builds** + (*dict*) -- A mapping of variants to extra module builds to include in a + package set: ``{variant: [N:S:V:C]}``. + +**pkgset_koji_inherit** = True + (*bool*) -- inherit builds from parent tags; we can turn it off only if we + have all builds tagged in a single tag + +**pkgset_koji_inherit_modules** = False + (*bool*) -- the same as above, but this only applies to modular tags. This + option applies to the content tags that contain the RPMs. + +**pkgset_repos** + (*dict*) -- A mapping of architectures to repositories with RPMs: ``{arch: + [repo]}``. Only use when ``pkgset_source = "repos"``. + +**pkgset_scratch_modules** + (*dict*) -- A mapping of variants to scratch module builds: ``{variant: + [N:S:V:C]}``. Requires ``mbs_api_url``. + +**pkgset_exclusive_arch_considers_noarch** = True + (*bool*) -- If a package includes ``noarch`` in its ``ExclusiveArch`` tag, + it will be included in all architectures since ``noarch`` is compatible + with everything. Set this option to ``False`` to ignore ``noarch`` in + ``ExclusiveArch`` and always consider only binary architectures. + +**pkgset_allow_reuse** = True + (*bool*) -- When set to ``True``, *Pungi* will try to reuse pkgset data + from the old composes specified by ``--old-composes``. When enabled, this + option can speed up new composes because it does not need to calculate the + pkgset data from Koji. However, if you block or unblock a package in Koji + (for example) between composes, then Pungi may not respect those changes + in your new compose. + + +Example +------- +:: + + sigkeys = [None] + pkgset_source = "koji" + pkgset_koji_tag = "f23" + + +Buildinstall Settings +===================== +Script or process that creates bootable images with +Anaconda installer is historically called +`buildinstall `_. + +Options +------- + +**buildinstall_method** + (*str*) -- "lorax" (f16+, rhel7+) or "buildinstall" (older releases) +**lorax_options** + (*list*) -- special options passed on to *lorax*. + + Format: ``[(variant_uid_regex, {arch|*: {option: name}})]``. + + Recognized options are: + * ``bugurl`` -- *str* (default ``None``) + * ``nomacboot`` -- *bool* (default ``True``) + * ``noupgrade`` -- *bool* (default ``True``) + * ``add_template`` -- *[str]* (default empty) + * ``add_arch_template`` -- *[str]* (default empty) + * ``add_template_var`` -- *[str]* (default empty) + * ``add_arch_template_var`` -- *[str]* (default empty) + * ``rootfs_size`` -- [*int*] (default empty) + * ``version`` -- [*str*] (default from ``treeinfo_version`` or + ``release_version``) -- used as ``--version`` and ``--release`` + argument on the lorax command line + * ``dracut_args`` -- [*[str]*] (default empty) override arguments for + dracut. Please note that if this option is used, lorax will not use any + other arguments, so you have to provide a full list and can not just + add something. + * ``skip_branding`` -- *bool* (default ``False``) + * ``squashfs_only`` -- *bool* (default ``False``) pass the --squashfs_only to Lorax. + * ``configuration_file`` -- (:ref:`scm_dict `) (default empty) pass the + specified configuration file to Lorax using the -c option. +**lorax_extra_sources** + (*list*) -- a variant/arch mapping with urls for extra source repositories + added to Lorax command line. Either one repo or a list can be specified. +**lorax_use_koji_plugin** = False + (*bool*) -- When set to ``True``, the Koji pungi_buildinstall task will be + used to execute Lorax instead of runroot. Use only if the Koji instance + has the pungi_buildinstall plugin installed. +**buildinstall_kickstart** + (:ref:`scm_dict `) -- If specified, this kickstart file will + be copied into each file and pointed to in boot configuration. +**buildinstall_topdir** + (*str*) -- Full path to top directory where the runroot buildinstall + Koji tasks output should be stored. This is useful in situation when + the Pungi compose is not generated on the same storage as the Koji task + is running on. In this case, Pungi can provide input repository for runroot + task using HTTP and set the output directory for this task to + ``buildinstall_topdir``. Once the runroot task finishes, Pungi will copy + the results of runroot tasks to the compose working directory. +**buildinstall_skip** + (*list*) -- mapping that defines which variants and arches to skip during + buildinstall; format: ``[(variant_uid_regex, {arch|*: True})]``. This is + only supported for lorax. +**buildinstall_allow_reuse** = False + (*bool*) -- When set to ``True``, *Pungi* will try to reuse buildinstall + results from old compose specified by ``--old-composes``. + +Example +------- +:: + + buildinstall_method = "lorax" + + # Enables macboot on x86_64 for all variants and builds upgrade images + # everywhere. + lorax_options = [ + ("^.*$", { + "x86_64": { + "nomacboot": False + } + "*": { + "noupgrade": False + } + }) + ] + + # Don't run buildinstall phase for Modular variant + buildinstall_skip = [ + ('^Modular', { + '*': True + }) + ] + + # Add another repository for lorax to install packages from + lorax_extra_sources = [ + ('^Simple$', { + '*': 'https://example.com/repo/$basearch/', + }) + ] + + +.. note:: + + It is advised to run buildinstall (lorax) in koji, + i.e. with **runroot enabled** for clean build environments, better logging, etc. + + +.. warning:: + + Lorax installs RPMs into a chroot. This involves running %post scriptlets + and they frequently run executables in the chroot. + If we're composing for multiple architectures, we **must** use runroot for this reason. + + +Gather Settings +=============== + +Options +------- + +**gather_method** [mandatory] + (*str*|*dict*) -- Options are ``deps``, ``nodeps`` and ``hybrid``. + Specifies whether and how package dependencies should be pulled in. + Possible configuration can be one value for all variants, or if configured + per-variant it can be a simple string ``hybrid`` or a a dictionary mapping + source type to a value of ``deps`` or ``nodeps``. Make sure only one regex + matches each variant, as there is no guarantee which value will be used if + there are multiple matching ones. All used sources must have a configured + method unless hybrid solving is used. + +**gather_fulltree** = False + (*bool*) -- When set to ``True`` all RPMs built from an SRPM will always be + included. Only use when ``gather_method = "deps"``. + +**gather_selfhosting** = False + (*bool*) -- When set to ``True``, *Pungi* will build a self-hosting tree by + following build dependencies. Only use when ``gather_method = "deps"``. + +**gather_allow_reuse** = False + (*bool*) -- When set to ``True``, *Pungi* will try to reuse gather results + from old compose specified by ``--old-composes``. + +**greedy_method** + (*str*) -- This option controls how package requirements are satisfied in + case a particular ``Requires`` has multiple candidates. + + * ``none`` -- the best packages is selected to satisfy the dependency and + only that one is pulled into the compose + * ``all`` -- packages that provide the symbol are pulled in + * ``build`` -- the best package is selected, and then all packages from the + same build that provide the symbol are pulled in + + .. note:: + As an example let's work with this situation: a package in the compose + has ``Requires: foo``. There are three packages with ``Provides: foo``: + ``pkg-a``, ``pkg-b-provider-1`` and ``pkg-b-provider-2``. The + ``pkg-b-*`` packages are build from the same source package. Best match + determines ``pkg-b-provider-1`` as best matching package. + + * With ``greedy_method = "none"`` only ``pkg-b-provider-1`` will be + pulled in. + * With ``greedy_method = "all"`` all three packages will be + pulled in. + * With ``greedy_method = "build" ``pkg-b-provider-1`` and + ``pkg-b-provider-2`` will be pulled in. + +**gather_backend** + (*str*) --This changes the entire codebase doing dependency solving, so it + can change the result in unpredictable ways. + + On Python 2, the choice is between ``yum`` or ``dnf`` and defaults to + ``yum``. On Python 3 ``dnf`` is the only option and default. + + Particularly the multilib work is performed differently by using + ``python-multilib`` library. Please refer to ``multilib`` option to see the + differences. + +**multilib** + (*list*) -- mapping of variant regexes and arches to list of multilib + methods + + Available methods are: + * ``none`` -- no package matches this method + * ``all`` -- all packages match this method + * ``runtime`` -- packages that install some shared object file + (``*.so.*``) will match. + * ``devel`` -- packages whose name ends with ``-devel`` or ``--static`` + suffix will be matched. When ``dnf`` is used, this method automatically + enables ``runtime`` method as well. With ``yum`` backend this method + also uses a hardcoded blacklist and whitelist. + * ``kernel`` -- packages providing ``kernel`` or ``kernel-devel`` match + this method (only in ``yum`` backend) + * ``yaboot`` -- only ``yaboot`` package on ``ppc`` arch matches this (only + in ``yum`` backend) + +.. _additional_packages: + +**additional_packages** + (*list*) -- additional packages to be included in a variant and + architecture; format: ``[(variant_uid_regex, {arch|*: [package_globs]})]`` + + The packages specified here are matched against RPM names, not any other + provides in the package not the name of source package. Shell globbing is + used, so wildcards are possible. The package can be specified as name only + or ``name.arch``. + + With ``dnf`` gathering backend, you can specify a debuginfo package to be + included. This is meant to include a package if autodetection does not get + it. If you add a debuginfo package that does not have anything else from + the same build included in the compose, the sources will not be pulled in. + +**filter_packages** + (*list*) -- packages to be excluded from a variant and architecture; + format: ``[(variant_uid_regex, {arch|*: [package_globs]})]`` + + See :ref:`additional_packages ` for details about + package specification. + +**filter_modules** + (*list*) -- modules to be excluded from a variant and architecture; + format: ``[(variant_uid_regex, {arch|*: [name:stream]})]`` + + Both name and stream can use shell-style globs. If stream is omitted, all + streams are removed. + + This option only applies to modules taken from Koji tags, not modules + explicitly listed in variants XML without any tags. + +**filter_system_release_packages** + (*bool*) -- for each variant, figure out the best system release package + and filter out all others. This will not work if a variant needs more than + one system release package. In such case, set this option to ``False``. + +**gather_prepopulate** = None + (:ref:`scm_dict `) -- If specified, you can use this to add + additional packages. The format of the file pointed to by this option is a + JSON mapping ``{variant_uid: {arch: {build: [package]}}}``. Packages added + through this option can not be removed by ``filter_packages``. + +**multilib_blacklist** + (*dict*) -- multilib blacklist; format: ``{arch|*: [package_globs]}``. + + See :ref:`additional_packages ` for details about + package specification. + +**multilib_whitelist** + (*dict*) -- multilib blacklist; format: ``{arch|*: [package_names]}``. The + whitelist must contain exact package names; there are no wildcards or + pattern matching. + +**gather_lookaside_repos** = [] + (*list*) -- lookaside repositories used for package gathering; format: + ``[(variant_uid_regex, {arch|*: [repo_urls]})]`` + + The repo_urls are passed to the depsolver, which can use packages in the + repos for satisfying dependencies, but the packages themselves are not + pulled into the compose. The repo_urls can contain $basearch variable, + which will be substituted with proper value by the depsolver. + + The repo_urls are used by repoclosure too, but it can't parse $basearch + currently and that will cause Repoclosure phase crashed. *repoclosure_strictness* + option could be used to stop running repoclosure. + + Please note that * as a wildcard matches all architectures but src. + +**hashed_directories** = False + (*bool*) -- put packages into "hashed" directories, for example + ``Packages/k/kernel-4.0.4-301.fc22.x86_64.rpm`` + +**check_deps** = True + (*bool*) -- Set to ``False`` if you don't want the compose to abort when + some package has broken dependencies. + +**require_all_comps_packages** = False + (*bool*) -- Set to ``True`` to abort compose when package mentioned in + comps file can not be found in the package set. When disabled (the + default), such cases are still reported as warnings in the log. + +**gather_source_mapping** + (*str*) -- JSON mapping with initial packages for the compose. The value + should be a path to JSON file with following mapping: ``{variant: {arch: + {rpm_name: [rpm_arch|None]}}}``. + +**gather_profiler** = False + (*bool*) -- When set to ``True`` the gather tool will produce additional + performance profiling information at the end of its logs. Only takes + effect when ``gather_backend = "dnf"``. + +**variant_as_lookaside** + (*list*) -- a variant/variant mapping that tells one or more variants in compose + has other variant(s) in compose as a lookaside. Only top level variants are + supported (not addons/layered products). Format: + ``[(variant_uid, variant_uid)]`` + + +Example +------- +:: + + gather_method = "deps" + greedy_method = "build" + check_deps = False + hashed_directories = True + + gather_method = { + "^Everything$": { + "comps": "deps" # traditional content defined by comps groups + }, + "^Modular$": { + "module": "nodeps" # Modules do not need dependencies + }, + "^Mixed$": { # Mixed content in one variant + "comps": "deps", + "module": "nodeps" + } + "^OtherMixed$": "hybrid", # Using hybrid depsolver + } + + additional_packages = [ + # bz#123456 + ('^(Workstation|Server)$', { + '*': [ + 'grub2', + 'kernel', + ], + }), + ] + + filter_packages = [ + # bz#111222 + ('^.*$', { + '*': [ + 'kernel-doc', + ], + }), + ] + + multilib = [ + ('^Server$', { + 'x86_64': ['devel', 'runtime'] + }) + ] + + multilib_blacklist = { + "*": [ + "gcc", + ], + } + + multilib_whitelist = { + "*": [ + "alsa-plugins-*", + ], + } + + # gather_lookaside_repos = [ + # ('^.*$', { + # '*': [ + # "https://dl.fedoraproject.org/pub/fedora/linux/releases/22/Everything/$basearch/os/", + # ], + # 'x86_64': [ + # "https://dl.fedoraproject.org/pub/fedora/linux/releases/22/Everything/source/SRPMS/", + # ] + # }), + # ] + + +.. note:: + + It is a good practice to attach bug/ticket numbers + to additional_packages, filter_packages, multilib_blacklist and multilib_whitelist + to track decisions. + + +Koji Settings +============= + + +Options +------- + +**koji_profile** + (*str*) -- koji profile name. This tells Pungi how to communicate with + your chosen Koji instance. See `Koji's documentation about profiles + `_ for more information about how + to set up your Koji client profile. In the examples, the profile name is + "koji", which points to Fedora's koji.fedoraproject.org. + +**global_runroot_method** + (*str*) -- global runroot method to use. If ``runroot_method`` is set + per Pungi phase using a dictionary, this option defines the default + runroot method for phases not mentioned in the ``runroot_method`` + dictionary. + +**runroot_method** + (*str*|*dict*) -- Runroot method to use. It can further specify + the runroot method in case the ``runroot`` is set to True. + + Available methods are: + * ``local`` -- runroot tasks are run locally + * ``koji`` -- runroot tasks are run in Koji + * ``openssh`` -- runroot tasks are run on remote machine connected using OpenSSH. + The ``runroot_ssh_hostnames`` for each architecture must be set and the + user under which Pungi runs must be configured to login as ``runroot_ssh_username`` + using the SSH key. + + The runroot method can also be set per Pungi phase using the dictionary + with phase name as key and runroot method as value. The default runroot + method is in this case defined by the ``global_runroot_method`` option. + +Example +------- +:: + + global_runroot_method = "koji" + runroot_method = { + "createiso": "local" + } + +**runroot_channel** + (*str*) -- name of koji channel + +**runroot_tag** + (*str*) -- name of koji **build** tag used for runroot + +**runroot_weights** + (*dict*) -- customize task weights for various runroot tasks. The values in + the mapping should be integers, the keys can be selected from the following + list. By default no weight is assigned and Koji picks the default one + according to policy. + + * ``buildinstall`` + * ``createiso`` + * ``ostree`` + * ``ostree_installer`` + +Example +------- +:: + + koji_profile = "koji" + runroot_channel = "runroot" + runroot_tag = "f23-build" + +Runroot "openssh" method settings +================================= + + +Options +------- + +**runroot_ssh_username** + (*str*) -- For ``openssh`` runroot method, configures the username used to login + the remote machine to run the runroot task. Defaults to "root". + +**runroot_ssh_hostnames** + (*dict*) -- For ``openssh`` runroot method, defines the hostname for each + architecture on which the runroot task should be running. Format: + ``{"x86_64": "runroot-x86-64.localhost.tld", ...}`` + +**runroot_ssh_init_template** + (*str*) [optional] -- For ``openssh`` runroot method, defines the command + to initializes the runroot task on the remote machine. This command is + executed as first command for each runroot task executed. + + The command can print a string which is then available as ``{runroot_key}`` + for other SSH commands. This string might be used to keep the context + across different SSH commands executed for single runroot task. + + The goal of this command is setting up the environment for real runroot + commands. For example preparing the unique mock environment, mounting the + desired file-systems, ... + + The command string can contain following variables which are replaced by + the real values before executing the init command: + + * ``{runroot_tag}`` - Tag to initialize the runroot environment from. + + When not set, no init command is executed. + +**runroot_ssh_install_packages_template** + (*str*) [optional] -- For ``openssh`` runroot method, defines the template + for command to install the packages requested to run the runroot task. + + The template string can contain following variables which are replaced by + the real values before executing the install command: + + * ``{runroot_key}`` - Replaced with the string returned by + ``runroot_ssh_init_template`` if used. This can be used to keep the track + of context of SSH commands belonging to single runroot task. + * ``{packages}`` - White-list separated list of packages to install. + + Example (The ``{runroot_key}`` is expected to be set to mock config file + using the ``runroot_ssh_init_template`` command.): + ``"mock -r {runroot_key} --install {packages}"`` + + When not set, no command to install packages on remote machine is executed. + +**runroot_ssh_run_template** + (*str*) [optional] -- For ``openssh`` runroot method, defines the template + for the main runroot command. + + The template string can contain following variables which are replaced by + the real values before executing the install command: + + * ``{runroot_key}`` - Replaced with the string returned by + ``runroot_ssh_init_template`` if used. This can be used to keep the track + of context of SSH commands belonging to single runroot task. + * ``{command}`` - Command to run. + + Example (The ``{runroot_key}`` is expected to be set to mock config file + using the ``runroot_ssh_init_template`` command.): + ``"mock -r {runroot_key} chroot -- {command}"`` + + When not set, the runroot command is run directly. + + +Extra Files Settings +==================== + + +Options +------- + +**extra_files** + (*list*) -- references to external files to be placed in os/ directory and + media; format: ``[(variant_uid_regex, {arch|*: [scm_dict]})]``. See + :ref:`scm_support` for details. If the dict specifies a ``target`` key, an + additional subdirectory will be used. + + +Example +------- +:: + + extra_files = [ + ('^.*$', { + '*': [ + # GPG keys + { + "scm": "rpm", + "repo": "fedora-repos", + "branch": None, + "file": [ + "/etc/pki/rpm-gpg/RPM-GPG-KEY-22-fedora", + ], + "target": "", + }, + # GPL + { + "scm": "git", + "repo": "https://pagure.io/pungi-fedora", + "branch": None, + "file": [ + "GPL", + ], + "target": "", + }, + ], + }), + ] + + +Extra Files Metadata +-------------------- +If extra files are specified a metadata file, ``extra_files.json``, is placed +in the ``os/`` directory and media. The checksums generated are determined by +``media_checksums`` option. This metadata file is in the format: + +:: + + { + "header": {"version": "1.0}, + "data": [ + { + "file": "GPL", + "checksums": { + "sha256": "8177f97513213526df2cf6184d8ff986c675afb514d4e68a404010521b880643" + }, + "size": 18092 + }, + { + "file": "release-notes/notes.html", + "checksums": { + "sha256": "82b1ba8db522aadf101dca6404235fba179e559b95ea24ff39ee1e5d9a53bdcb" + }, + "size": 1120 + } + ] + } + + +CreateISO Settings +================== + +Options +------- + +**createiso_skip** = False + (*list*) -- mapping that defines which variants and arches to skip during createiso; format: [(variant_uid_regex, {arch|*: True})] + +**createiso_max_size** + (*list*) -- mapping that defines maximum expected size for each variant and + arch. If the ISO is larger than the limit, a warning will be issued. + + Format: ``[(variant_uid_regex, {arch|*: number})]`` + +**createiso_max_size_is_strict** + (*list*) -- Set the value to ``True`` to turn the warning from + ``createiso_max_size`` into a hard error that will abort the compose. + If there are multiple matches in the mapping, the check will be strict if + at least one match says so. + + Format: ``[(variant_uid_regex, {arch|*: bool})]`` + +**create_jigdo** = True + (*bool*) -- controls the creation of jigdo from ISO + +**create_optional_isos** = False + (*bool*) -- when set to ``True``, ISOs will be created even for + ``optional`` variants. By default only variants with type ``variant`` or + ``layered-product`` will get ISOs. + +**createiso_break_hardlinks** = False + (*bool*) -- when set to ``True``, all files that should go on the ISO and + have a hardlink will be first copied into a staging directory. This should + work around a bug in ``genisoimage`` including incorrect link count in the + image, but it is at the cost of having to copy a potentially significant + amount of data. + + The staging directory is deleted when ISO is successfully created. In that + case the same task to create the ISO will not be re-runnable. + +**createiso_use_xorrisofs** = False + (*bool*) -- when set to True, use ``xorrisofs`` for creating ISOs instead + of ``genisoimage``. + +**iso_size** = 4700000000 + (*int|str*) -- size of ISO image. The value should either be an integer + meaning size in bytes, or it can be a string with ``k``, ``M``, ``G`` + suffix (using multiples of 1024). + +**split_iso_reserve** = 10MiB + (*int|str*) -- how much free space should be left on each disk. The format + is the same as for ``iso_size`` option. + +**iso_hfs_ppc64le_compatible** = True + (*bool*) -- when set to False, the Apple/HFS compatibility is turned off + for ppc64le ISOs. This option only makes sense for bootable products, and + affects images produced in *createiso* and *extra_isos* phases. + +.. note:: + + Source architecture needs to be listed explicitly. + Excluding '*' applies only on binary arches. + Jigdo causes significant increase of time to ISO creation. + + +Example +------- +:: + + createiso_skip = [ + ('^Workstation$', { + '*': True, + 'src': True + }), + ] + + +.. _auto-version: + +Automatic generation of version and release +=========================================== + +Version and release values for certain artifacts can be generated automatically +based on release version, compose label, date, type and respin. This can be +used to shorten the config and keep it the same for multiple uses. + ++----------------------------+-------------------+--------------+--------------+--------+------------------+ +| Compose ID | Label | Version | Date | Respin | Release | ++============================+===================+==============+==============+========+==================+ +| ``F-Rawhide-20170406.n.0`` | ``-`` | ``Rawhide`` | ``20170406`` | ``0`` | ``20170406.n.0`` | ++----------------------------+-------------------+--------------+--------------+--------+------------------+ +| ``F-26-20170329.1`` | ``Alpha-1.6`` | ``26_Alpha`` | ``20170329`` | ``1`` | ``1.6`` | ++----------------------------+-------------------+--------------+--------------+--------+------------------+ +| ``F-Atomic-25-20170407.0`` | ``RC-20170407.0`` | ``25`` | ``20170407`` | ``0`` | ``20170407.0`` | ++----------------------------+-------------------+--------------+--------------+--------+------------------+ +| ``F-Atomic-25-20170407.0`` | ``-`` | ``25`` | ``20170407`` | ``0`` | ``20170407.0`` | ++----------------------------+-------------------+--------------+--------------+--------+------------------+ + +All non-``RC`` milestones from label get appended to the version. For release +either label is used or date, type and respin. + + +Common options for Live Images, Live Media and Image Build +========================================================== + +All images can have ``ksurl``, ``version``, ``release`` and ``target`` +specified. Since this can create a lot of duplication, there are global options +that can be used instead. + +For each of the phases, if the option is not specified for a particular +deliverable, an option named ``_