Mock

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
m (remove Plague mention)
(delete this page)
 
(48 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{autolang|base=yes}}
 
  
= 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.
+
= This page is not maintained anymore. It has been moved to https://github.com/rpm-software-management/mock/wiki =
 
+
== Status ==
+
Mock is currently being used for all Fedora builds. It is called by [[Koji]] to build chroots and packages.
+
 
+
== Download ==
+
https://fedorahosted.org/mock/ has all the latest builds.  It can be installed with "yum install mock".
+
 
+
To check out the current code:
+
* <code>git clone git://git.fedorahosted.org/git/mock.git mock</code>
+
 
+
== Setup ==
+
 
+
All users that are to use mock must be added to the 'mock' group.
+
 
+
<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.
+
 
+
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.
+
 
+
== 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
+
 
+
<code>mock -r <configname> rebuild package-1.2-3.src.rpm</code>
+
 
+
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>
+
 
+
== Using Mock inside your git sandbox ==
+
 
+
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.
+
 
+
 
+
== Security Considerations ==
+
=== Build User ===
+
 
+
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.
+
 
+
To create the user, and put them into the mock group, run:
+
 
+
<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 ==
+
If you encounter a bug running mock, please file it in [https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora&component=mock Bugzilla], product "Fedora", component mock ([https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&product=Fedora&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]).
+
 
+
== See Also ==
+
 
+
* [[Extras/MockTricks]]  has some useful tips for 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.
+

Latest revision as of 11:36, 11 October 2016


[edit] This page is not maintained anymore. It has been moved to https://github.com/rpm-software-management/mock/wiki