├── .gitignore ├── fedmsg_atomic_composer ├── __init__.py ├── templates │ ├── repo.mako │ └── mock.mako ├── cli.py ├── consumer.py ├── config.py └── composer.py ├── MANIFEST.in ├── systemd └── fedmsg-atomic-composer.service ├── fedmsg.d └── config.py ├── setup.py ├── CHANGELOG.md ├── test.py ├── rpm └── fedmsg-atomic-composer.spec ├── README.rst └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.py[co] 2 | *.sw* 3 | *.egg-info 4 | dist 5 | -------------------------------------------------------------------------------- /fedmsg_atomic_composer/__init__.py: -------------------------------------------------------------------------------- 1 | from .composer import AtomicComposer 2 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.rst LICENSE test.py config.ini 2 | graft fedmsg_atomic_composer 3 | graft systemd 4 | graft rpm 5 | graft fedmsg.d 6 | graft config 7 | global-exclude *.pyc *.sw* 8 | -------------------------------------------------------------------------------- /systemd/fedmsg-atomic-composer.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | After=network.target 3 | 4 | [Service] 5 | ExecStart=/usr/bin/fedmsg-hub 6 | Type=simple 7 | User=rpmostreecompose 8 | Group=rpmostreecompose 9 | 10 | [Install] 11 | WantedBy=multi-user.target 12 | -------------------------------------------------------------------------------- /fedmsg_atomic_composer/templates/repo.mako: -------------------------------------------------------------------------------- 1 | ## A mako template for yum repo files. 2 | ## These are written along-side of the treefile.json, 3 | ## which are then picked up by rpm-ostree. 4 | % for repo, url in repos.items(): 5 | 6 | ## Skip repos that aren't enabled in the treefile 7 | % if repo not in treefile['repos']: 8 | <% continue %> 9 | % endif 10 | 11 | [${repo}] 12 | name=Fedora ${version} ${repo} 13 | % if 'metalink' in url: 14 | metalink=${url} 15 | % else: 16 | baseurl=${url} 17 | % endif 18 | gpgcheck=1 19 | gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-${version}-${arch} 20 | enabled=1 21 | metadata_expire=0 22 | skip_if_unavailable=False 23 | %endfor 24 | -------------------------------------------------------------------------------- /fedmsg.d/config.py: -------------------------------------------------------------------------------- 1 | config = dict( 2 | fedmsg_atomic_composer=True, 3 | config_key='fedmsg_atomic_composer', 4 | fedmsg_atomic_topic=[ 5 | 'org.fedoraproject.prod.bodhi.updates.fedora.sync', 6 | 'org.fedoraproject.prod.compose.branched.rsync.complete', 7 | 'org.fedoraproject.prod.compose.rawhide.rsync.complete', 8 | 'org.fedoraproject.stg.bodhi.updates.fedora.sync', 9 | 'org.fedoraproject.stg.compose.branched.rsync.complete', 10 | 'org.fedoraproject.stg.compose.rawhide.rsync.complete', 11 | 'org.fedoraproject.dev.bodhi.updates.fedora.sync', 12 | 'org.fedoraproject.dev.compose.branched.rsync.complete', 13 | 'org.fedoraproject.dev.compose.rawhide.rsync.complete' 14 | ], 15 | ) 16 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | setup( 4 | name='fedmsg-atomic-composer', 5 | version='2017.1', 6 | license='GPLv3', 7 | description='Composes Atomic rpm-ostrees when Fedora repositories are updated', 8 | author='Luke Macken', 9 | author_email='lmacken@redhat.com', 10 | url='https://github.com/fedora-infra/fedmsg-atomic-composer', 11 | install_requires=['fedmsg', 'mako'], 12 | tests_require=['mock'], 13 | packages=['fedmsg_atomic_composer'], 14 | package_data={'fedmsg_atomic_composer': ['templates/*.mako']}, 15 | entry_points=""" 16 | [moksha.consumer] 17 | fedmsg_atomic_composer = fedmsg_atomic_composer.consumer:AtomicConsumer 18 | [console_scripts] 19 | fedmsg-atomic-composer-cli = fedmsg_atomic_composer.cli:cli 20 | """, 21 | ) 22 | -------------------------------------------------------------------------------- /fedmsg_atomic_composer/templates/mock.mako: -------------------------------------------------------------------------------- 1 | config_opts['root'] = '${mock}' 2 | config_opts['target_arch'] = '${arch}' 3 | config_opts['dist'] = '${git_branch}' # only useful for --resultdir variable subst 4 | config_opts['releasever'] = '${version}' 5 | config_opts['chroot_setup_cmd'] = 'install yum rpm-ostree ostree' 6 | config_opts['extra_chroot_dirs'] = ['/run/lock'] 7 | config_opts['nspawn_args'] = ['--capability=CAP_NET_ADMIN'] 8 | config_opts['plugin_conf']['bind_mount_enable'] = True 9 | config_opts['plugin_conf']['bind_mount_opts']['dirs'].append(('${work_dir}', '${work_dir}')) 10 | config_opts['plugin_conf']['bind_mount_opts']['dirs'].append(('${tmp_dir}', '${tmp_dir}')) 11 | % for path in mount_dirs: 12 | config_opts['plugin_conf']['bind_mount_opts']['dirs'].append(('${path}', '${path}')) 13 | %endfor 14 | 15 | config_opts['yum.conf'] = """ 16 | [main] 17 | cachedir=/var/cache/yum 18 | debuglevel=2 19 | reposdir=/dev/null 20 | logfile=/var/log/yum.log 21 | retries=20 22 | obsoletes=1 23 | gpgcheck=0 24 | assumeyes=1 25 | metadata_expire=0 26 | 27 | % for repo_name, url in repos.items(): 28 | 29 | ## Skip repos that aren't enabled in the treefile 30 | % if repo_name not in treefile['repos']: 31 | <% continue %> 32 | % endif 33 | 34 | [${repo_name}] 35 | name=Fedora ${version} ${repo_name} 36 | % if 'metalink' in url: 37 | metalink=${url} 38 | % else: 39 | baseurl=${url} 40 | % endif 41 | enabled=1 42 | cost=5000 43 | % endfor 44 | """ 45 | config_opts['yum_common_opts'] = [] 46 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## 2017.1 4 | 5 | This release fixes a bug where exit codes were being used backwards to make log level decisions 6 | ([#20](https://github.com/fedora-infra/fedmsg-atomic-composer/pull/20)). 7 | 8 | 9 | ## 2017.0 10 | 11 | This is a bugfix release, with the following commits: 12 | 13 | * AtomicConsumer now has a config key 14 | ([5e32653f](https://github.com/fedora-infra/fedmsg-atomic-composer/commit/5e32653f)). 15 | * stderr messages are now logged at info and not error level 16 | ([eba7e334](https://github.com/fedora-infra/fedmsg-atomic-composer/commit/eba7e334)). 17 | * Set enabled to 1 in repo.mako 18 | ([1b51be98](https://github.com/fedora-infra/fedmsg-atomic-composer/commit/1b51be98)). 19 | * Explicity install ostree in the mock config 20 | ([fd58aee1](https://github.com/fedora-infra/fedmsg-atomic-composer/commit/fd58aee1)). 21 | * Enable CAP_NET_ADMIN for systemd-nspawn in the mock config 22 | ([#19](https://github.com/fedora-infra/fedmsg-atomic-composer/pull/19)). 23 | 24 | ## 2016.3 25 | 26 | The following features and changes in behavior are introduced in this version: 27 | 28 | * Default to using ```/var/lib/fedora-atomic``` instead of ```/srv/fedora-atomic``` 29 | ([6b6ecf18](https://github.com/fedora-infra/fedmsg-atomic-composer/commit/6b6ecf18)). 30 | * Return the ref and commitid of the composed tree at the end 31 | ([#7](https://github.com/fedora-infra/fedmsg-atomic-composer/pull/7)). 32 | 33 | 34 | The 2016.3 release contains the following bug fixes: 35 | 36 | * ```--new-chroot``` is now only used with rpm-ostree and not with mock 37 | ([#4](https://github.com/fedora-infra/fedmsg-atomic-composer/issues/4)). 38 | * ```/var/tmp``` is used for the temporary working directory instead of ```/tmp``` 39 | ([544d7091](https://github.com/fedora-infra/fedmsg-atomic-composer/commit/544d7091)). 40 | * Log files are now closed during cleanup 41 | ([#9](https://github.com/fedora-infra/fedmsg-atomic-composer/pull/9)). 42 | -------------------------------------------------------------------------------- /test.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import os 3 | import mock 4 | import shutil 5 | import unittest 6 | import tempfile 7 | 8 | from fedmsg_atomic_composer import AtomicComposer 9 | 10 | class FakeHub(object): 11 | def __init__(self): 12 | self.config = { 13 | 'config_key': 'fedmsg_atomic_composer', 14 | 'topic_prefix': 'org.fedoraproject', 15 | 'environment': 'dev', 16 | 'releng_fedmsg_certname': None, 17 | 'touch_dir': tempfile.mkdtemp(), 18 | 'output_dir': tempfile.mkdtemp(), 19 | 'production_repos': tempfile.mkdtemp(), 20 | 'local_repos': tempfile.mkdtemp(), 21 | 'topic': ['org.fedoraproject.test'], 22 | 'trees': ['rawhide'], 23 | } 24 | 25 | def subscribe(self, *args, **kw): 26 | pass 27 | 28 | updates_msg = { 29 | "body": { 30 | "i": 1, 31 | "msg": { 32 | "bytes": "352.15M", 33 | "deleted": "470", 34 | "release": "19", 35 | "repo": "updates" 36 | }, 37 | "msg_id": "2014-74193fa4-bed3-40c3-9a0e-db2bcedf41ba", 38 | "timestamp": 1413724658.0, 39 | "topic": "org.fedoraproject.prod.bodhi.updates.fedora.sync" 40 | } 41 | } 42 | 43 | 44 | class TestAtomicComposer(unittest.TestCase): 45 | 46 | def setUp(self): 47 | self.composer = AtomicComposer(FakeHub()) 48 | 49 | def tearDown(self): 50 | pass 51 | 52 | @mock.patch('fedmsg_atomic_composer.AtomicComposer.sync_in') 53 | @mock.patch('fedmsg_atomic_composer.AtomicComposer.sync_out') 54 | @mock.patch('fedmsg_atomic_composer.AtomicComposer.compose_complete') 55 | def test_updates(self, *args): 56 | fakehub = FakeHub() 57 | touch_dir = fakehub.config['touch_dir'] 58 | os.makedirs(os.path.join(touch_dir, 'f19')) 59 | self.masher = AtomicComposer(fakehub) 60 | self.masher.consume(updates_msg) 61 | #call.assert_called_with(['touch', os.path.join(fakehub.config['touch_dir'], 62 | # '19', 'treecompose')]) 63 | shutil.rmtree(fakehub.config['touch_dir']) 64 | shutil.rmtree(fakehub.config['output_dir']) 65 | shutil.rmtree(fakehub.config['production_repos']) 66 | shutil.rmtree(fakehub.config['local_repos']) 67 | 68 | 69 | if __name__ == '__main__': 70 | unittest.main() 71 | -------------------------------------------------------------------------------- /fedmsg_atomic_composer/cli.py: -------------------------------------------------------------------------------- 1 | # This program is free software: you can redistribute it and/or modify 2 | # it under the terms of the GNU General Public License as published by 3 | # the Free Software Foundation, either version 3 of the License, or 4 | # (at your option) any later version. 5 | # 6 | # This program is distributed in the hope that it will be useful, 7 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 8 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 9 | # GNU General Public License for more details. 10 | # 11 | # You should have received a copy of the GNU General Public License 12 | # along with this program. If not, see . 13 | 14 | import click 15 | import time 16 | import tempfile 17 | import pprint 18 | 19 | from fedmsg_atomic_composer.composer import AtomicComposer 20 | from fedmsg_atomic_composer.config import config 21 | 22 | def get_release(release): 23 | releases = config['releases'] 24 | if release not in releases: 25 | raise click.BadParameter('Unknown release. Valid releases are: %s' % 26 | releases.keys()) 27 | return releases[release] 28 | 29 | 30 | @click.group() 31 | def cli(): 32 | pass 33 | 34 | 35 | @cli.command(help='Compose an ostree for a given release') 36 | @click.argument('release') 37 | def compose(release): 38 | release = get_release(release) 39 | composer = AtomicComposer() 40 | result = composer.compose(release) 41 | if result['result'] == 'success': 42 | click.echo('{name} tree successfuly composed'.format(**result)) 43 | else: 44 | click.echo('{name} tree compose failed'.format(**result)) 45 | click.echo(str(result)) 46 | 47 | click.echo('Log: {log_file}'.format(**result)) 48 | 49 | 50 | @cli.command(help='List available releases') 51 | @click.option('--json', is_flag=True) 52 | def releases(json): 53 | if json: 54 | click.echo(pprint.pformat(config['releases'])) 55 | else: 56 | for release in config['releases']: 57 | click.echo(release) 58 | 59 | 60 | @cli.command() 61 | @click.argument('release') 62 | def clean(release): 63 | release = get_release(release) 64 | composer = AtomicComposer() 65 | release['tmp_dir'] = tempfile.mkdtemp() 66 | release['timestamp'] = time.strftime('%y%m%d.%H%M') 67 | composer.setup_logger(release) 68 | composer.generate_mock_config(release) 69 | composer.mock_cmd(release, '--clean') 70 | 71 | 72 | if __name__ == '__main__': 73 | cli() 74 | -------------------------------------------------------------------------------- /rpm/fedmsg-atomic-composer.spec: -------------------------------------------------------------------------------- 1 | %global modname fedmsg_atomic_composer 2 | 3 | Name: fedmsg-atomic-composer 4 | Version: 2016.2 5 | Release: 1%{?dist} 6 | Summary: Composes atomic trees when Fedora repositories are updated 7 | 8 | License: GPLv3 9 | URL: https://github.com/fedora-infra/fedmsg-atomic-composer 10 | Source0: %{name}-%{version}.tar.bz2 11 | BuildArch: noarch 12 | 13 | BuildRequires: python-devel 14 | BuildRequires: python-setuptools 15 | 16 | Requires: mock 17 | Requires: python-mako 18 | Requires: python-click 19 | 20 | %description 21 | This is a Fedmsg consumer that listens for when the Fedora 22 | updates/rawhide/branched repositories sync with the master mirror, and 23 | then triggers Atomic OSTree composes. 24 | 25 | %package consumer 26 | Summary: A fedmsg-driven atomic tree composer 27 | 28 | # Version requirement for specifying a list of topics 29 | Requires: python-moksha-hub >= 1.4.4 30 | Requires: fedmsg-hub 31 | 32 | %description consumer 33 | This sub-package contains a fedmsg consumer that triggers Atomic tree composes 34 | when new Fedora repositories sync to the master mirror. 35 | 36 | %prep 37 | %setup -q 38 | 39 | 40 | %build 41 | %{__python} setup.py build 42 | 43 | 44 | %install 45 | %{__python} setup.py install -O1 --skip-build --root=%{buildroot} 46 | mkdir -p %{buildroot}/%{_sharedstatedir}/lib/fedora-atomic/ 47 | 48 | install -D -m644 fedmsg.d/config.py %{buildroot}%{_sysconfdir}/fedmsg.d/%{modname}.py 49 | 50 | %if 0%{?rhel} && 0%{?rhel} > 6 51 | install -D -m644 systemd/%{name}.service %{buildroot}%{_unitdir}/%{name}.service 52 | %endif 53 | 54 | %files 55 | %doc README.rst LICENSE 56 | %{_bindir}/%{name}-cli 57 | %{python_sitelib}/%{modname}/ 58 | %{python_sitelib}/%{modname}*.egg-info 59 | %attr(775, root, mock) /%{_sharedstatedir}/fedora-atomic/ 60 | 61 | %files consumer 62 | %config(noreplace) %{_sysconfdir}/fedmsg.d/%{modname}.py* 63 | %if 0%{?rhel} && 0%{?rhel} > 6 64 | %{_unitdir}/%{name}.service 65 | %endif 66 | 67 | 68 | %changelog 69 | * Wed Jan 06 2016 Luke Macken - 2016.1-1 70 | - Latest upstream release 71 | 72 | * Tue Jan 20 2015 Luke Macken - 2015.1-1 73 | - Latest upstream release 74 | 75 | * Tue Dec 16 2014 Luke Macken - 2014.2-1 76 | - Latest upstream release 77 | 78 | * Mon Dec 15 2014 Luke Macken - 2014.1-1 79 | - Initial production release 80 | 81 | * Tue Nov 18 2014 Luke Macken - 0.0.1-2 82 | - Create a consumer subpackage 83 | 84 | * Mon Oct 20 2014 Luke Macken - 0.0.1-1 85 | - Initial package 86 | -------------------------------------------------------------------------------- /fedmsg_atomic_composer/consumer.py: -------------------------------------------------------------------------------- 1 | # This program is free software: you can redistribute it and/or modify 2 | # it under the terms of the GNU General Public License as published by 3 | # the Free Software Foundation, either version 3 of the License, or 4 | # (at your option) any later version. 5 | # 6 | # This program is distributed in the hope that it will be useful, 7 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 8 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 9 | # GNU General Public License for more details. 10 | # 11 | # You should have received a copy of the GNU General Public License 12 | # along with this program. If not, see . 13 | 14 | import fedmsg.consumers 15 | 16 | from twisted.internet import reactor 17 | 18 | from .composer import AtomicComposer 19 | 20 | 21 | class AtomicConsumer(fedmsg.consumers.FedmsgConsumer): 22 | """A fedmsg-driven atomic ostree composer. 23 | 24 | This consumer runs in the fedmsg-hub and reacts to whenever repositories 25 | sync to the master mirror. 26 | """ 27 | config_key = 'atomic_composer' 28 | 29 | def __init__(self, hub, *args, **kw): 30 | # Map all of the options from our /etc/fedmsg.d config to self 31 | for key, item in hub.config.items(): 32 | setattr(self, key, item) 33 | 34 | self.topic = getattr(self, 'fedmsg_atomic_topic', None) 35 | 36 | super(AtomicConsumer, self).__init__(hub, *args, **kw) 37 | 38 | if not self.topic: 39 | self.log.warn("No 'fedmsg_atomic_topic' set.") 40 | 41 | def consume(self, msg): 42 | """Called with each incoming fedmsg. 43 | 44 | From here we trigger an rpm-ostree compose by touching a specific file 45 | under the `touch_dir`. Then our `doRead` method is called with the 46 | output of the rpm-ostree-toolbox treecompose, which we monitor to 47 | determine when it has completed. 48 | """ 49 | self.log.info(msg) 50 | body = msg['body'] 51 | topic = body['topic'] 52 | repo = None 53 | 54 | if 'rawhide' in topic: 55 | arch = body['msg']['arch'] 56 | self.log.info('New rawhide %s compose ready', arch) 57 | repo = 'rawhide' 58 | elif 'branched' in topic: 59 | arch = body['msg']['arch'] 60 | branch = body['msg']['branch'] 61 | self.log.info('New %s %s branched compose ready', branch, arch) 62 | log = body['msg']['log'] 63 | if log != 'done': 64 | self.log.warn('Compose not done?') 65 | return 66 | repo = branch 67 | elif 'updates.fedora' in topic: 68 | self.log.info('New Fedora %(release)s %(repo)s compose ready', 69 | body['msg']) 70 | repo = 'f%(release)s-%(repo)s' % body['msg'] 71 | else: 72 | self.log.warn('Unknown topic: %s', topic) 73 | 74 | release = self.releases[repo] 75 | reactor.callInThread(self.compose, release) 76 | 77 | def compose(self, release): 78 | self.composer = AtomicComposer() 79 | result = self.composer.compose(release) 80 | if result['result'] == 'success': 81 | self.log.info(result) 82 | else: 83 | self.log.error(result) 84 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | fedmsg-atomic-composer 2 | ====================== 3 | 4 | Retirement 5 | ---------- 6 | 7 | As of Bodhi 3.0.0, this package is no longer used. Thus is it retired and deprecated. 8 | 9 | 10 | Features 11 | -------- 12 | 13 | Triggers `Atomic `_ ostree composes when Fedora 14 | updates/rawhide/branched repositories are updated. 15 | 16 | You can also trigger composes via a command-line tool or Python API. 17 | 18 | * Simple JSON configuration 19 | * Compose trees in a lightweight `systemd-nspawn `_ container 20 | * Dynamic atomic `treefile `_ generation 21 | * Dynamic yum repo & mock configuration generation 22 | * Seperate logfiles for each compose 23 | * Python API 24 | * A fedmsg consumer that can trigger composes when new repos are available 25 | * A simple `fedmsg-atomic-composer-cli` command-line interface 26 | * Ability to rsync trees locally and remotely 27 | 28 | Bootstrap 29 | --------- 30 | 31 | .. code-block:: 32 | 33 | sudo yum -y install git rpmdevtools python-{devel,mock} 34 | rpmdev-setuptree 35 | 36 | 37 | Configure 38 | --------- 39 | 40 | All of the configuration lives in the `config.py` in JSON format. You can 41 | define all of your releases like so: 42 | 43 | .. code-block:: bash 44 | 45 | config = { 46 | 'releases': { 47 | 'f21-updates': { 48 | 'name': 'f21-updates', 49 | 'repo': 'updates', 50 | 'version': '21', 51 | 'arch': 'x86_64', 52 | 53 | # Here you define your OSTree treefile configuration 54 | 'tree': 'docker-host', 55 | 'treefile': { 56 | 'include': 'fedora-atomic-docker-host.json', 57 | 'ref': 'fedora-atomic/f21/x86_64/updates/docker-host', 58 | 'repos': ['fedora-21', 'updates'], 59 | }, 60 | 61 | # The name of the mock container to build and maintain 62 | 'mock': 'fedora-21-updates-x86_64', 63 | 64 | # The git branch to use in the `git_repo` for the parent 65 | # treefile & repo configurations 66 | 'git_branch': 'f21', 67 | 68 | # Add or overwrite yum repository name:urls. This lets you 69 | # compose trees against your own repositories. 70 | 'repos': {}, 71 | }, … 72 | 73 | Build & Install locally 74 | ----------------------- 75 | 76 | .. code-block:: bash 77 | 78 | ./build.sh 79 | 80 | 81 | Composing a tree via the CLI 82 | ---------------------------- 83 | 84 | .. code-block:: bash 85 | 86 | $ fedmsg-atomic-composer-cli compose f21-updates 87 | 88 | .. code-block:: bash 89 | 90 | $ fedmsg-atomic-composer-cli releases 91 | f21-updates 92 | f21-updates-testing 93 | rawhide 94 | 95 | $ fedmsg-atomic-composer-cli releases --json 96 | {'f21-updates': {'arch': 'x86_64', 97 | 'canonical_dir': '/var/lib/fedora-atomic/21', 98 | 'git_branch': 'f21', 99 | 'git_cache': '/var/lib/fedora-atomic/work/fedora-atomic.git', 100 | 'git_repo': 'https://git.fedorahosted.org/git/fedora-atomic.git', 101 | … 102 | 103 | 104 | Using the Python API 105 | -------------------- 106 | 107 | To compose a tree via the Python API, all you need to do is pass the 108 | `compose` method a `release` dictionary from the `config.py`. 109 | 110 | .. code-block:: python 111 | 112 | from fedmsg_atomic_composer.composer import AtomicComposer 113 | from fedmsg_atomic_composer.config import config 114 | 115 | release = config['releases']['f21-updates'] 116 | composer = AtomicComposer() 117 | result = composer.compose(release) 118 | 119 | 120 | Enable & Monitor the fedmsg consumer 121 | ------------------------------------ 122 | 123 | .. code-block:: bash 124 | 125 | systemctl enable fedmsg-atomic-composer 126 | systemctl start fedmsg-atomic-composer 127 | journalctl -f -u fedmsg-atomic-composer 128 | 129 | Triggering locally via fedmsg 130 | ----------------------------- 131 | 132 | :note: This requires having the `fedmsg-relay` package installed and the 133 | service running. 134 | 135 | .. code-block:: bash 136 | 137 | fedmsg-logger --modname 'bodhi' --topic 'updates.fedora.sync' --message='{"release": "21", "repo": "updates"}' --json-input 138 | fedmsg-logger --modname 'compose' --topic 'rawhide.rsync.complete' --message='{"arch":"x86_64"}' --json-input 139 | fedmsg-logger --modname 'compose' --topic 'branched.rsync.complete' --message='{"arch":"x86_64"}' --json-input 140 | -------------------------------------------------------------------------------- /fedmsg_atomic_composer/config.py: -------------------------------------------------------------------------------- 1 | # This program is free software: you can redistribute it and/or modify 2 | # it under the terms of the GNU General Public License as published by 3 | # the Free Software Foundation, either version 3 of the License, or 4 | # (at your option) any later version. 5 | # 6 | # This program is distributed in the hope that it will be useful, 7 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 8 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 9 | # GNU General Public License for more details. 10 | # 11 | # You should have received a copy of the GNU General Public License 12 | # along with this program. If not, see . 13 | """ 14 | The primary atomic composer configuration. 15 | 16 | The appropriate entry in the 'releases' must be passed into 17 | the AtomicComposer.composer method. 18 | 19 | The code at the bottom maps+expands the paths & 20 | commands to each of the releases, for ease of 21 | configuration. 22 | """ 23 | 24 | # Check if we're running on RHEL6 and disable 25 | # `mock --new-chroot` and `rpm-ostree --workdir-tmpfs` 26 | import platform 27 | dist = platform.dist() 28 | rhel6 = dist[0] == 'redhat' and int(float(dist[1])) == 6 29 | 30 | config = dict( 31 | releases={ 32 | 'f21-updates': { 33 | 'name': 'f21-updates', 34 | 'repo': 'updates', 35 | 'version': '21', 36 | 'arch': 'x86_64', 37 | 38 | # OSTree treefile configuration 39 | # https://github.com/projectatomic/rpm-ostree/blob/master/doc/treefile.md 40 | 'tree': 'docker-host', 41 | 'treefile': { 42 | 'include': 'fedora-atomic-docker-host.json', 43 | 'ref': 'fedora-atomic/f21/x86_64/updates/docker-host', 44 | 'repos': ['fedora-21', 'updates'], 45 | 'packages': [], 46 | }, 47 | 48 | # The name of the mock container to build and maintain 49 | 'mock': 'fedora-21-updates-x86_64', 50 | 51 | # The git branch to use in the `git_repo` for the parent 52 | # treefile & repo configurations 53 | 'git_branch': 'f21', 54 | 55 | # Add or overwrite yum repository name:urls. This lets you 56 | # compose trees against your own repositories. 57 | 'repos': {}, 58 | }, 59 | 60 | 'f21-updates-testing': { 61 | 'name': 'f21-updates-testing', 62 | 'repo': 'updates-testing', 63 | 'version': '21', 64 | 'arch': 'x86_64', 65 | 'tree': 'docker-host', 66 | 'treefile': { 67 | 'include': 'fedora-atomic-docker-host.json', 68 | 'ref': 'fedora-atomic/f21/x86_64/updates-testing/docker-host', 69 | 'repos': ['fedora-21', 'updates', 'updates-testing'], 70 | }, 71 | 'git_branch': 'f21', 72 | 'mock': 'fedora-21-updates-testing-x86_64', 73 | 'repos': {}, 74 | }, 75 | 76 | 'rawhide': { 77 | 'name': 'rawhide', 78 | 'repo': 'rawhide', 79 | 'version': 'rawhide', 80 | 'arch': 'x86_64', 81 | 'tree': 'docker-host', 82 | 'treefile': { 83 | 'include': 'fedora-atomic-docker-host.json', 84 | 'ref': 'fedora-atomic/rawhide/x86_64/docker-host', 85 | 'repos': ['rawhide'], 86 | }, 87 | 'git_branch': 'f21', 88 | 'mock': 'fedora-rawhide-x86_64', 89 | 'repos': {}, 90 | }, 91 | }, 92 | 93 | # Package repositories to use in the mock container and ostree compose 94 | repos={ 95 | 'rawhide': 'https://mirrors.fedoraproject.org/metalink?repo={version}&arch={arch}', 96 | 'fedora-{version}': 'https://mirrors.fedoraproject.org/metalink?repo=fedora-{version}&arch={arch}', 97 | 'updates': 'https://mirrors.fedoraproject.org/metalink?repo=updates-released-f{version}&arch={arch}', 98 | 'updates-testing': 'https://mirrors.fedoraproject.org/metalink?repo=updates-testing-f{version}&arch={arch}', 99 | }, 100 | 101 | # Output directories 102 | prod_dir='/var/lib/fedora-atomic', 103 | work_dir='{prod_dir}/work', 104 | canonical_dir='{prod_dir}/{version}', 105 | output_dir='{work_dir}/{version}/{arch}/{tree}', 106 | log_dir='{work_dir}/logs/{version}/{arch}/{repo}/{tree}', 107 | 108 | # A list of other directories to mount in the mock container 109 | mount_dirs=[], 110 | 111 | # The git repo containing our parent treefiles and yum repos 112 | git_repo='https://git.fedorahosted.org/git/fedora-atomic.git', 113 | git_cache='{work_dir}/fedora-atomic.git', 114 | # Some branches contain custom .repo files that we don't want to use 115 | delete_repo_files=True, 116 | 117 | # Mock command 118 | mock_cmd='/usr/bin/mock -r {mock}', 119 | mock_clean=True, 120 | 121 | # OSTree commands 122 | ostree_init='/usr/bin/ostree --repo={output_dir} init --mode=archive-z2', 123 | ostree_compose='/usr/bin/rpm-ostree compose tree' + 124 | (rhel6 and ' ' or ' --workdir-tmpfs ') + '--repo={output_dir} %s', 125 | ostree_summary='/usr/bin/ostree --repo={output_dir} summary --update', 126 | 127 | # Bi-directional syncing 128 | #rsync_in_objs='/usr/bin/rsync -rvp --ignore-existing {canonical_dir}/objects/ {output_dir}/objects/', 129 | #rsync_in_rest='/usr/bin/rsync -rvp --exclude=objects/ {canonical_dir}/ {output_dir}/', 130 | #rsync_out_objs='/usr/bin/rsync -rvp --ignore-existing {output_dir}/objects/ {canonical_dir}/objects/', 131 | #rsync_out_rest='/usr/bin/rsync -rvp --exclude=objects/ {output_dir}/ {canonical_dir}/', 132 | 133 | # Define the config keys to map to each release, in the appropriate order 134 | map_to_release=('prod_dir', 'work_dir', 'output_dir', 'log_dir', 135 | 'git_repo', 'git_cache', 'mock_cmd', 'ostree_init', 136 | 'ostree_compose', 'ostree_summary', 'canonical_dir', 137 | 'repos', 'rsync_in_objs', 'rsync_in_rest', 'rsync_out_objs', 138 | 'rsync_out_rest', 'mount_dirs', 'mock_clean', 139 | 'delete_repo_files'), 140 | ) 141 | 142 | # Map and expand variables to each release 143 | for key in config.get('map_to_release', []): 144 | for name, release in config['releases'].items(): 145 | if key in config: 146 | value = config[key] 147 | if isinstance(value, dict): 148 | release[key] = {} 149 | for k, v in value.items(): 150 | k = k.format(**release) 151 | release[key][k] = v.format(**release) 152 | elif isinstance(value, (list, tuple)): 153 | release[key] = [] 154 | for item in value: 155 | release[key].append(item.format(**release)) 156 | elif isinstance(value, bool): 157 | release[key] = value 158 | else: 159 | release[key] = value.format(**release) 160 | -------------------------------------------------------------------------------- /fedmsg_atomic_composer/composer.py: -------------------------------------------------------------------------------- 1 | # This program is free software: you can redistribute it and/or modify 2 | # it under the terms of the GNU General Public License as published by 3 | # the Free Software Foundation, either version 3 of the License, or 4 | # (at your option) any later version. 5 | # 6 | # This program is distributed in the hope that it will be useful, 7 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 8 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 9 | # GNU General Public License for more details. 10 | # 11 | # You should have received a copy of the GNU General Public License 12 | # along with this program. If not, see . 13 | 14 | import os 15 | import copy 16 | import json 17 | import glob 18 | import time 19 | import shutil 20 | import logging 21 | import tempfile 22 | import traceback 23 | import subprocess 24 | import pkg_resources 25 | 26 | from datetime import datetime 27 | from mako.template import Template 28 | 29 | 30 | class AtomicComposer(object): 31 | """An atomic ostree composer""" 32 | 33 | def compose(self, release): 34 | release = copy.deepcopy(release) 35 | # We need to use /var/tmp because systemd-nspawn will mount 36 | # a tmpfs on /tmp in the container. 37 | release['tmp_dir'] = tempfile.mkdtemp(dir='/var/tmp') 38 | release['timestamp'] = time.strftime('%y%m%d.%H%M') 39 | try: 40 | self.setup_logger(release) 41 | self.log.debug(release) 42 | self.update_configs(release) 43 | self.generate_mock_config(release) 44 | self.init_mock(release) 45 | self.sync_in(release) 46 | self.ostree_init(release) 47 | self.generate_repo_files(release) 48 | ref, commitid = self.ostree_compose(release) 49 | self.update_ostree_summary(release) 50 | self.sync_out(release) 51 | 52 | release['ref'] = ref 53 | release['commitid'] = commitid 54 | release['result'] = 'success' 55 | self.cleanup(release) 56 | except: 57 | if hasattr(self, 'log'): 58 | self.log.exception('Compose failed') 59 | else: 60 | traceback.print_exc() 61 | release['result'] = 'failed' 62 | finally: 63 | self.cleanup_logger() 64 | return release 65 | 66 | def setup_logger(self, release): 67 | name = '{name}-{timestamp}'.format(**release) 68 | logger = logging.getLogger(name) 69 | logger.setLevel(logging.DEBUG) 70 | log_dir = release['log_dir'] 71 | log_file = os.path.join(log_dir, name) 72 | release['log_file'] = log_file 73 | if not os.path.isdir(log_dir): 74 | os.makedirs(log_dir) 75 | stdout = logging.StreamHandler() 76 | self.log_handler = logging.FileHandler(log_file) 77 | log_format = ('%(asctime)s - %(levelname)s - %(filename)s:' 78 | '%(lineno)d - %(message)s') 79 | formatter = logging.Formatter(log_format) 80 | self.log_handler.setFormatter(formatter) 81 | self.log_handler.setLevel(logging.DEBUG) 82 | stdout.setFormatter(formatter) 83 | stdout.setLevel(logging.DEBUG) 84 | logger.addHandler(self.log_handler) 85 | logger.addHandler(stdout) 86 | self.log = logger 87 | 88 | def cleanup(self, release): 89 | """Cleanup any temporary files after the compose""" 90 | shutil.rmtree(release['tmp_dir']) 91 | 92 | def cleanup_logger(self): 93 | """Clean up logger to close out file handles. 94 | 95 | After this is called, writing to self.log will get logs ending up 96 | getting discarded. 97 | """ 98 | self.log_handler.close() 99 | self.log.removeHandler(self.log_handler) 100 | 101 | def update_configs(self, release): 102 | """ Update the fedora-atomic.git repositories for a given release """ 103 | git_repo = release['git_repo'] 104 | git_cache = release['git_cache'] 105 | if not os.path.isdir(git_cache): 106 | self.call(['git', 'clone', '--mirror', git_repo, git_cache]) 107 | else: 108 | self.call(['git', 'fetch', '--all', '--prune'], cwd=git_cache) 109 | git_dir = release['git_dir'] = os.path.join(release['tmp_dir'], 110 | os.path.basename(git_repo)) 111 | self.call(['git', 'clone', '-b', release['git_branch'], 112 | git_cache, git_dir]) 113 | 114 | if release['delete_repo_files']: 115 | for repo_file in glob.glob(os.path.join(git_dir, '*.repo')): 116 | self.log.info('Deleting %s' % repo_file) 117 | os.unlink(repo_file) 118 | 119 | def mock_cmd(self, release, *cmd, **kwargs): 120 | """Run a mock command in the chroot for a given release""" 121 | fmt = '{mock_cmd}' 122 | if kwargs.get('new_chroot') is True: 123 | fmt +=' --new-chroot' 124 | fmt += ' --configdir={mock_dir}' 125 | return self.call(fmt.format(**release).split() 126 | + list(cmd)) 127 | 128 | def init_mock(self, release): 129 | """Initialize/update our mock chroot""" 130 | root = '/var/lib/mock/%s' % release['mock'] 131 | if not os.path.isdir(root): 132 | self.mock_cmd(release, '--init') 133 | self.log.info('mock chroot initialized') 134 | else: 135 | if release.get('mock_clean'): 136 | self.mock_cmd(release, '--clean') 137 | self.mock_cmd(release, '--init') 138 | self.log.info('mock chroot cleaned & initialized') 139 | else: 140 | self.mock_cmd(release, '--update') 141 | self.log.info('mock chroot updated') 142 | 143 | def generate_mock_config(self, release): 144 | """Dynamically generate our mock configuration""" 145 | mock_tmpl = pkg_resources.resource_string(__name__, 'templates/mock.mako') 146 | mock_dir = release['mock_dir'] = os.path.join(release['tmp_dir'], 'mock') 147 | mock_cfg = os.path.join(release['mock_dir'], release['mock'] + '.cfg') 148 | os.mkdir(mock_dir) 149 | for cfg in ('site-defaults.cfg', 'logging.ini'): 150 | os.symlink('/etc/mock/%s' % cfg, os.path.join(mock_dir, cfg)) 151 | with file(mock_cfg, 'w') as cfg: 152 | mock_out = Template(mock_tmpl).render(**release) 153 | self.log.debug('Writing %s:\n%s', mock_cfg, mock_out) 154 | cfg.write(mock_out) 155 | 156 | def mock_chroot(self, release, cmd, **kwargs): 157 | """Run a commend in the mock container for a release""" 158 | return self.mock_cmd(release, '--chroot', cmd, **kwargs) 159 | 160 | def generate_repo_files(self, release): 161 | """Dynamically generate our yum repo configuration""" 162 | repo_tmpl = pkg_resources.resource_string(__name__, 'templates/repo.mako') 163 | repo_file = os.path.join(release['git_dir'], '%s.repo' % release['repo']) 164 | with file(repo_file, 'w') as repo: 165 | repo_out = Template(repo_tmpl).render(**release) 166 | self.log.debug('Writing repo file %s:\n%s', repo_file, repo_out) 167 | repo.write(repo_out) 168 | self.log.info('Wrote repo configuration to %s', repo_file) 169 | 170 | def ostree_init(self, release): 171 | """Initialize the OSTree for a release""" 172 | out = release['output_dir'].rstrip('/') 173 | base = os.path.dirname(out) 174 | if not os.path.isdir(base): 175 | self.log.info('Creating %s', base) 176 | os.makedirs(base, mode=0755) 177 | if not os.path.isdir(out): 178 | self.mock_chroot(release, release['ostree_init']) 179 | 180 | def ostree_compose(self, release): 181 | """Compose the OSTree in the mock container""" 182 | start = datetime.utcnow() 183 | treefile = os.path.join(release['git_dir'], 'treefile.json') 184 | cmd = release['ostree_compose'] % treefile 185 | with file(treefile, 'w') as tree: 186 | json.dump(release['treefile'], tree) 187 | # Only use new_chroot for the invocation, as --clean and --new-chroot are buggy together right now 188 | out, err, rcode = self.mock_chroot(release, cmd, new_chroot=True) 189 | ref = None 190 | commitid = None 191 | for line in out.split('\n'): 192 | if ' => ' in line: 193 | # This line is the: ref => commitid line 194 | line = line.replace('\n', '') 195 | ref, _, commitid = line.partition(' => ') 196 | self.log.info('rpm-ostree compose complete (%s), ref %s, commitid %s', 197 | datetime.utcnow() - start, ref, commitid) 198 | return ref, commitid 199 | 200 | def update_ostree_summary(self, release): 201 | """Update the ostree summary file and return a path to it""" 202 | self.log.info('Updating the ostree summary for %s', release['name']) 203 | self.mock_chroot(release, release['ostree_summary']) 204 | return os.path.join(release['output_dir'], 'summary') 205 | 206 | def sync_in(self, release): 207 | """Sync the canonical repo to our local working directory""" 208 | tree = release['canonical_dir'] 209 | if os.path.exists(tree) and release.get('rsync_in_objs'): 210 | out = release['output_dir'] 211 | if not os.path.isdir(out): 212 | self.log.info('Creating %s', out) 213 | os.makedirs(out) 214 | self.call(release['rsync_in_objs']) 215 | self.call(release['rsync_in_rest']) 216 | 217 | def sync_out(self, release): 218 | """Sync our tree to the canonical location""" 219 | if release.get('rsync_out_objs'): 220 | tree = release['canonical_dir'] 221 | if not os.path.isdir(tree): 222 | self.log.info('Creating %s', tree) 223 | os.makedirs(tree) 224 | self.call(release['rsync_out_objs']) 225 | self.call(release['rsync_out_rest']) 226 | 227 | def call(self, cmd, **kwargs): 228 | """A simple subprocess wrapper""" 229 | if isinstance(cmd, basestring): 230 | cmd = cmd.split() 231 | self.log.info('Running %s', cmd) 232 | p = subprocess.Popen(cmd, stdout=subprocess.PIPE, 233 | stderr=subprocess.PIPE, **kwargs) 234 | out, err = p.communicate() 235 | if out: 236 | self.log.info(out) 237 | if err: 238 | if p.returncode == 0: 239 | self.log.info(err) 240 | else: 241 | self.log.error(err) 242 | if p.returncode != 0: 243 | self.log.error('returncode = %d' % p.returncode) 244 | raise Exception 245 | return out, err, p.returncode 246 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | --------------------------------------------------------------------------------