1 """Invirt build utilities.
3 This module contains utility functions used by both the invirtibuilder
4 and the remctl submission scripts that insert items into its queue.
10 from debian_bundle import changelog
11 from debian_bundle import deb822
13 import invirt.common as c
14 from invirt.config import structs as config
17 _QUEUE_DIR = '/var/lib/invirt-dev/queue'
18 _REPO_DIR = '/srv/git'
19 _LOG_DIR = '/var/log/invirt/builds'
20 _HOOKS_DIR = '/usr/share/invirt-dev/build.d'
23 class InvalidBuild(ValueError):
28 """Return the path to the git repo for a given package."""
29 return os.path.join(_REPO_DIR, 'invirt/packages', '%s.git' % package)
31 def ensureValidPackage(package):
32 """Perform some basic sanity checks that the requested repo is in a
33 subdirectory of _REPO_DIR/invirt/packages. This prevents weirdness
34 such as submitting a package like '../prod/...git'. Also ensures that
36 # TODO: this might be easier just to regex
37 repo = os.path.abspath(getRepo(package))
38 parent_dir = os.path.dirname(repo)
39 prefix = os.path.join(_REPO_DIR, 'invirt/packages')
40 if not parent_dir.startswith(prefix):
41 raise InvalidBuild('Invalid package name %s' % package)
42 elif not os.path.exists(repo):
43 raise InvalidBuild('Nonexisting package %s' % package)
45 def canonicalize_commit(package, commit, shorten=False):
50 return c.captureOutput(['git', 'rev-parse'] + flags + [commit],
51 cwd=getRepo(package)).strip()
53 def pocketToGit(pocket):
54 """Map a pocket in the configuration to a git branch."""
55 return getattr(getattr(config.build.pockets, pocket), 'git', pocket)
58 def pocketToApt(pocket):
59 """Map a pocket in the configuration to an apt repo pocket."""
60 return getattr(getattr(config.build.pockets, pocket), 'apt', pocket)
63 def getGitFile(package, ref, path):
64 """Return the contents of a path from a git ref in a package."""
65 return c.captureOutput(['git', 'cat-file', 'blob', '%s:%s' % (ref, path)],
69 def getChangelog(package, ref):
70 """Get a changelog object for a given ref in a given package.
72 This returns a debian_bundle.changelog.Changelog object for a
73 given ref of a given package.
75 return changelog.Changelog(getGitFile(package, ref, 'debian/changelog'))
78 def getVersion(package, ref):
79 """Get the version of a given package at a particular ref."""
80 return getChangelog(package, ref).get_version()
83 def validateBuild(pocket, package, commit):
84 """Given the parameters of a new build, validate that build.
86 The checks this function performs vary based on whether or not the
87 pocket is configured with allow_backtracking.
89 A build of a pocket without allow_backtracking set must be a
90 fast-forward of the previous revision, and the most recent version
91 in the changelog most be strictly greater than the version
92 currently in the repository.
94 In all cases, this revision of the package can only have the same
95 version number as any other revision currently in the apt
96 repository if they have the same commit ID.
98 If it's unspecified, it is assumed that pocket do not
101 If this build request fails validation, this function will raise a
102 InvalidBuild exception, with information about why the validation
105 If this build request can be satisfied by copying the package from
106 another pocket, then this function returns that pocket. Otherwise,
109 ensureValidPackage(package)
110 package_repo = getRepo(package)
111 new_version = getVersion(package, commit)
115 for p in config.build.pockets:
120 current_commit = c.captureOutput(['git', 'rev-parse', b],
121 cwd=package_repo).strip()
122 current_version = getVersion(package, b)
124 if current_version == new_version:
125 if current_commit == commit:
128 raise InvalidBuild('Version %s of %s already available is in '
129 'pocket %s from commit %s' %
130 (new_version, package, p, current_commit))
132 if not config.build.pockets[pocket].get('allow_backtracking', False):
133 branch = pocketToGit(pocket)
134 current_version = getVersion(package, branch)
135 if new_version <= current_version:
136 raise InvalidBuild('New version %s of %s is not newer than '
137 'version %s currently in pocket %s' %
138 (new_version, package, current_version, pocket))
140 # Almost by definition, A is a fast-forward of B if B..A is
142 if not c.captureOutput(['git', 'rev-list', '%s..%s' % (commit, branch)]):
143 raise InvalidBuild('New commit %s of %s is not a fast-forward of'
144 'commit currently in pocket %s' %
145 (commit, package, pocket))