From Fedora Project Wiki

m (Fix option tag)
(28 intermediate revisions by 11 users not shown)
Line 3: Line 3:
= Mock =
= Mock =


Mock creates chroots and builds packages in them. Its only task is to reliably populate a chroot and attempt to build a package in that chroot.
Mock is a tool for building packages. It can build packages for different architectures and different Fedora or RHEL versions than the build host has. Mock creates chroots and builds packages in them. Its only task is to reliably populate a chroot and attempt to build a package in that chroot.
 
Mock also offers a multi-package tool, mockchain, that can build chains of packages that depend on each other.
 
Mock is capable of building SRPMs  from source configuration management if the mock-scm package is present, then building the SRPM into RPMs. See --scm-enable in the documentation.


== Status ==
== Status ==
Mock is currently being used for all Fedora builds. It is called by [[Projects/Plague|  Plague]] (<=FC-6) and [[Koji|  Koji]] (>=F-7) to build chroots and packages.
 
Mock is currently being used for all Fedora builds. It is called by [[Koji]] and [https://copr.fedoraproject.org Copr] to build chroots and packages.


== Download ==
== Download ==
https://fedorahosted.org/mock/ has all the latest builds.  It can be installed with "yum install mock".


To check out the current code:
If you want to contribute to code, please checkout https://fedorahosted.org/mock/ for more informations.
* <code>git clone git://git.fedorahosted.org/git/mock.git mock</code>
 
Otherwise just run "dnf install mock".


== Setup ==
== Setup ==
All users that are to use mock must be added to the 'mock' group.
All users that are to use mock must be added to the 'mock' group.


<code>usermod -a G mock [User name] && newgrp mock</code>  
<code>usermod -a -G mock [User name] && newgrp mock</code>  


Configuration files are in /etc/mock.  Mock versions 0.8.0 and higher cache the downloaded rpm packages (via the yum_cache plugin), which speeds up subsequent builds by a considerable margin. Nevertheless, you may wish to change the default configuration to point to local repositories to speed up builds.
Configuration files are in /etc/mock.  Mock versions 0.8.0 and higher cache the downloaded rpm packages (via the yum_cache plugin), which speeds up subsequent builds by a considerable margin. Nevertheless, you may wish to change the default configuration to point to local repositories to speed up builds.


By default, builds are done in /var/lib/mock, so be sure you have room. Starting with mock 0.8.0 and higher, you can change this via the 'basedir' config option.
By default, builds are done in /var/lib/mock, so be sure you have room. Starting with mock 0.8.0 and higher, you can change this via the 'basedir' config option.
== Plugins ==
* [[Projects/Mock/Plugin/BindMount|bind_mount]] - bind mountpoints inside the chroot
* [[Projects/Mock/Plugin/CCache|ccache]] - compiler cache plugin
* [[Projects/Mock/Plugin/ChrootScan|chroot_scan]] - allows you to retrieve build artifacts from buildroot (e.g. additional logs, coredumps)
* [[Projects/Mock/Plugin/CompressLogs|compress_logs]] - compress logs
* [[Projects/Mock/Plugin/LvmRoot|lvm_root]] - caching buildroots using LVM
* [[Projects/Mock/Plugin/Mount|mount]] - allows you to mount directories into chroot
* [[Projects/Mock/Plugin/PackageState|package_state]] - dumps list of available and installed packages
* [[Projects/Mock/Plugin/PMRequest|pm_request]] - Executes package manager commands requested by processes runninng in the chroot.
* [[Projects/Mock/Plugin/RootCache|root_cache]] - cache buildroots (as tar file).
* [[Projects/Mock/Plugin/Scm|scm]] - SCM integration module - builds directly from Git or Svn.
* [[Projects/Mock/Plugin/SELinux|selinux]] - on SELinux enabled box, this plugin will pretend, that SELinux is disabled in build environment.
* [[Projects/Mock/Plugin/Sign|sign]] - call command on the produced rpm.
* [[Projects/Mock/Plugin/Tmpfs|tmpfs]] - mount buildroot directory as tmpfs
* [[Projects/Mock/Plugin/YumCache|yum_cache]] - mount /var/cache/yum of your machine to chroot


== Using Mock outside your git sandbox ==
== Using Mock outside your git sandbox ==
Create your SRPM using 'rpmbuild -bs'. Then change to the directory where your srpm was created.
Create your SRPM using 'rpmbuild -bs'. Then change to the directory where your srpm was created.


Now you can start mock with
Now you can start mock with


<code>mock -r <configfile> rebuild package-1.2-3.src.rpm</code>
<code>mock -r <configname> rebuild package-1.2-3.src.rpm</code>


where <configfile> is the name of a configuration from /etc/mock/.
where <configname> is the name of a configuration from /etc/mock/, without the /etc/mock path prefix and without the .cfg suffix.
 
If using mock version older than 0.8.8 or on a system with python 2.4, and building i386 packages on x86_64, prepend setarch i386 to the mock command line: setarch i386 mock -r <configfile> rebuild package-1.2-3.src.rpm. Newer versions of mock no longer need the setarch command, although it does not hurt anything if it is there.


Note that you can track the progress of mock using the logs stored in <code>/var/lib/mock/<configfile>/result</code>
Note that you can track the progress of mock using the logs stored in <code>/var/lib/mock/<configfile>/result</code>


== Using Mock inside your git sandbox ==
== Mock on EL 6 and EL 7: Yum, and DNF ==


You only need to type 'fedpkg mockbuild' to start a mock build. The used architecture depends on the directory where you start the mock build.
Starting with the Rawhide builds for Fedora 23, Mock requires DNF to run properly. Since not all parts of DNF are available on EL 6 and EL 7, Mock cannot be run there with the default configuration.


There are however two workarounds available:


== Security Considerations ==
* For one time runs it is possible to pass <code>--yum</code> as an option on the command line.
=== Build User ===
* To make yum the default package manager, a change in <code>/etc/mock/site-defaults.cfg</code> or inside of any <code>/etc/mock/*.cfg</code> file is necessary:


It's recommended you use a user account other than your normal user account to do the builds, just to be safe. You wouldn't want the build user to "accidentally" have access to your GPG or SSH keys.
<code>config_opts['package_manager'] = 'yum'</code>


To create the user, and put them into the mock group, run:
For more information, please see the [http://miroslav.suchy.cz/blog/archives/2015/05/20/why_mock_does_not_work_on_el_6_and_el7_and_how_to_fix_it/index.html blog entry by Miroslav Suchý].
 
<code>adduser -m -G mock build </code>
 
Then remember to 'su' - build prior to running mock.
 
=== Untrusted Users Using Mock ===
 
Beware that adding a user to the mock group means that the user can easily get root access on the machine without providing a password:
<pre>
$ /usr/bin/mock --init -r fedora-15-i386
$ /usr/bin/mock --shell -r fedora-15-i386
mock-chroot> chmod u+s bin/bash
$ /var/lib/mock/fedora-15-i386/root/bin/bash -p
# cat /etc/shadow
</pre>
 
== Using ==
 
<pre>
Usage:
    usage:
          mock [options] {--init|--clean|--scrub=[all,chroot,cache,root-cache,c-cache,yum-cache]}
          mock [options] [--rebuild] /path/to/srpm(s)
          mock [options] --buildsrpm {--spec /path/to/spec --sources /path/to/src|--scm-enable [--scm-option key=value]}
          mock [options] {--shell|--chroot} <cmd>
          mock [options] --installdeps {SRPM|RPM}
          mock [options] --install PACKAGE
          mock [options] --copyin path [..path] destination
          mock [options] --copyout path [..path] destination
          mock [options] --scm-enable [--scm-option key=value]
 
 
Options:
  --version            show program's version number and exit
  -h, --help            show this help message and exit
  --rebuild            rebuild the specified SRPM(s)
  --buildsrpm          Build a SRPM from spec (--spec ...) and sources
                        (--sources ...) or from SCM
  --shell              run the specified command interactively within the
                        chroot. Default command: /bin/sh
  --chroot              run the specified command noninteractively within the
                        chroot.
  --clean              completely remove the specified chroot
  --scrub=[all|chroot|cache|root-cache|c-cache|yum-cache]
                        completely remove the specified chroot or cache dir or
                        all of the chroot and cache
  --init                initialize the chroot, do not build anything
  --installdeps        install build dependencies for a specified SRPM
  --install            install packages using yum
  --update              update installed packages using yum
  --orphanskill        Kill all processes using specified buildroot.
  --copyin              Copy file(s) into the specified chroot
  --copyout            Copy file(s) from the specified chroot
  -r CHROOT, --root=CHROOT
                        chroot name/config file name default: default
  --offline            activate 'offline' mode.
  --no-clean            do not clean chroot before building
  --cleanup-after      Clean chroot after building. Use with --resultdir.
                        Only active for 'rebuild'.
  --no-cleanup-after    Dont clean chroot after building. If automatic cleanup
                        is enabled, use this to disable.
  --arch=ARCH          Sets kernel personality().
  --target=RPMBUILD_ARCH
                        passed to rpmbuild as --target
  -D 'MACRO EXPR', --define='MACRO EXPR'
                        define an rpm macro (may be used more than once)
  --with=option        enable configure option for build (may be used more
                        than once)
  --without=option      disable configure option for build (may be used more
                        than once)
  --resultdir=RESULTDIR
                        path for resulting files to be put
  --uniqueext=UNIQUEEXT
                        Arbitrary, unique extension to append to buildroot
                        directory name
  --configdir=CONFIGDIR
                        Change where config files are found
  --rpmbuild_timeout=RPMBUILD_TIMEOUT
                        Fail build if rpmbuild takes longer than 'timeout'
                        seconds
  --unpriv              Drop privileges before running command when using
                        --chroot
  --cwd=DIR            Change to the specified directory (relative to the
                        chroot) before running command when using --chroot
  --spec=SPEC          Specifies spec file to use to build an SRPM (used only
                        with --buildsrpm)
  --sources=SOURCES    Specifies sources (either a single file or a directory
                        of files)to use to build an SRPM (used only with
                        --buildsrpm)
  -v, --verbose        verbose build
  -q, --quiet          quiet build
  --trace              Enable internal mock tracing output.
  --enable-plugin=ENABLED_PLUGINS
                        Enable plugin. Currently-available plugins: ['tmpfs',
                        'root_cache', 'yum_cache', 'bind_mount', 'ccache',
                        'selinux']
  --disable-plugin=DISABLED_PLUGINS
                        Disable plugin. Currently-available plugins: ['tmpfs',
                        'root_cache', 'yum_cache', 'bind_mount', 'ccache',
                        'selinux']
  --print-root-path    print path to chroot root
  --scm-enable          build from SCM repository
  --scm-option=SCM_OPTS
                        define an SCM option (may be used more than once)
</pre>
 
For example, to rebuild a package for i386 on the development branch of Fedora:
 
* <code>mock --rebuild -r fedora-devel-i386 /path/to/rpm</code>
 
See /etc/mock for the available targets. If you have the bash-completion package installed, it will tab complete the targets for you.


== Problems ==
== Problems ==
Line 165: Line 73:


If your problem is specific to EPEL, then [https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora%20EPEL&component=mock file it] against the "Fedora EPEL" product instead ([https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&product=Fedora%20EPEL&component=mock&bug_status=NEW&bug_status=ASSIGNED&bug_status=MODIFIED&bug_status=ON_DEV&bug_status=ON_QA&bug_status=VERIFIED&bug_status=FAILS_QA&bug_status=RELEASE_PENDING&bug_status=POST Open Bugs]).
If your problem is specific to EPEL, then [https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora%20EPEL&component=mock file it] against the "Fedora EPEL" product instead ([https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&product=Fedora%20EPEL&component=mock&bug_status=NEW&bug_status=ASSIGNED&bug_status=MODIFIED&bug_status=ON_DEV&bug_status=ON_QA&bug_status=VERIFIED&bug_status=FAILS_QA&bug_status=RELEASE_PENDING&bug_status=POST Open Bugs]).
== Generate custom config file ==
Of course you may copy one and edit it manually, however if koji is already using such an config?
Then you can use  '''mock-config --help''' for information how to generate one. E.g.:
koji mock-config --tag f21-build --arch=aarch64  f21


== See Also ==
== See Also ==


* [[Extras/MockTricks]]  has some useful tips for using mock.
* [[Using_Mock_to_test_package_builds]]  has some useful tips for using mock.
* [[Docs/Drafts/MockSetupUsingLocalMirror]]  Setting up a local mirror using Mock.
* [[Docs/Drafts/MockSetupUsingLocalMirror]]  Setting up a local mirror using Mock.
* [[Legacy/Mock]]  has some useful tips for building packages in mock for older Fedora and Red Hat Linux releases.
* [[Legacy/Mock]]  has some useful tips for building packages in mock for older Fedora and Red Hat Linux releases.
* [http://miroslav.suchy.cz/blog/archives/2015/05/28/increase_mock_performance_-_build_packages_in_memory/index.html Increase Mock performance].

Revision as of 09:10, 1 September 2015

Mock

Mock is a tool for building packages. It can build packages for different architectures and different Fedora or RHEL versions than the build host has. Mock creates chroots and builds packages in them. Its only task is to reliably populate a chroot and attempt to build a package in that chroot.

Mock also offers a multi-package tool, mockchain, that can build chains of packages that depend on each other.

Mock is capable of building SRPMs from source configuration management if the mock-scm package is present, then building the SRPM into RPMs. See --scm-enable in the documentation.

Status

Mock is currently being used for all Fedora builds. It is called by Koji and Copr to build chroots and packages.

Download

If you want to contribute to code, please checkout https://fedorahosted.org/mock/ for more informations.

Otherwise just run "dnf install mock".

Setup

All users that are to use mock must be added to the 'mock' group.

usermod -a -G mock [User name] && newgrp mock

Configuration files are in /etc/mock. Mock versions 0.8.0 and higher cache the downloaded rpm packages (via the yum_cache plugin), which speeds up subsequent builds by a considerable margin. Nevertheless, you may wish to change the default configuration to point to local repositories to speed up builds.

By default, builds are done in /var/lib/mock, so be sure you have room. Starting with mock 0.8.0 and higher, you can change this via the 'basedir' config option.

Plugins

  • bind_mount - bind mountpoints inside the chroot
  • ccache - compiler cache plugin
  • chroot_scan - allows you to retrieve build artifacts from buildroot (e.g. additional logs, coredumps)
  • compress_logs - compress logs
  • lvm_root - caching buildroots using LVM
  • mount - allows you to mount directories into chroot
  • package_state - dumps list of available and installed packages
  • pm_request - Executes package manager commands requested by processes runninng in the chroot.
  • root_cache - cache buildroots (as tar file).
  • scm - SCM integration module - builds directly from Git or Svn.
  • selinux - on SELinux enabled box, this plugin will pretend, that SELinux is disabled in build environment.
  • sign - call command on the produced rpm.
  • tmpfs - mount buildroot directory as tmpfs
  • yum_cache - mount /var/cache/yum of your machine to chroot

Using Mock outside your git sandbox

Create your SRPM using 'rpmbuild -bs'. Then change to the directory where your srpm was created.

Now you can start mock with

mock -r <configname> rebuild package-1.2-3.src.rpm

where <configname> is the name of a configuration from /etc/mock/, without the /etc/mock path prefix and without the .cfg suffix.

Note that you can track the progress of mock using the logs stored in /var/lib/mock/<configfile>/result

Mock on EL 6 and EL 7: Yum, and DNF

Starting with the Rawhide builds for Fedora 23, Mock requires DNF to run properly. Since not all parts of DNF are available on EL 6 and EL 7, Mock cannot be run there with the default configuration.

There are however two workarounds available:

  • For one time runs it is possible to pass --yum as an option on the command line.
  • To make yum the default package manager, a change in /etc/mock/site-defaults.cfg or inside of any /etc/mock/*.cfg file is necessary:

config_opts['package_manager'] = 'yum'

For more information, please see the blog entry by Miroslav Suchý.

Problems

If you encounter a bug running mock, please file it in Bugzilla, product "Fedora", component mock (Open Bugs).

If your problem is specific to EPEL, then file it against the "Fedora EPEL" product instead (Open Bugs).

Generate custom config file

Of course you may copy one and edit it manually, however if koji is already using such an config? Then you can use mock-config --help for information how to generate one. E.g.: 

koji mock-config --tag f21-build --arch=aarch64  f21

See Also

Retrieved from "https://fedoraproject.org/w/index.php?title=Mock&oldid=421316"