Shawn O. Pearce | 43c3d9e | 2009-03-04 14:26:50 -0800 | [diff] [blame] | 1 | # Copyright (C) 2009 The Android Open Source Project |
| 2 | # |
| 3 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | # you may not use this file except in compliance with the License. |
| 5 | # You may obtain a copy of the License at |
| 6 | # |
| 7 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | # |
| 9 | # Unless required by applicable law or agreed to in writing, software |
| 10 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | # See the License for the specific language governing permissions and |
| 13 | # limitations under the License. |
| 14 | |
Mike Frysinger | 23411d3 | 2020-09-02 04:31:10 -0400 | [diff] [blame] | 15 | import json |
Shawn O. Pearce | 43c3d9e | 2009-03-04 14:26:50 -0800 | [diff] [blame] | 16 | import os |
| 17 | import sys |
| 18 | |
Shawn O. Pearce | c7a4eef | 2009-03-05 10:32:38 -0800 | [diff] [blame] | 19 | from command import PagedCommand |
Shawn O. Pearce | 43c3d9e | 2009-03-04 14:26:50 -0800 | [diff] [blame] | 20 | |
David Pursehouse | 819827a | 2020-02-12 15:20:19 +0900 | [diff] [blame] | 21 | |
Shawn O. Pearce | c7a4eef | 2009-03-05 10:32:38 -0800 | [diff] [blame] | 22 | class Manifest(PagedCommand): |
Shawn O. Pearce | 43c3d9e | 2009-03-04 14:26:50 -0800 | [diff] [blame] | 23 | common = False |
Shawn O. Pearce | c7a4eef | 2009-03-05 10:32:38 -0800 | [diff] [blame] | 24 | helpSummary = "Manifest inspection utility" |
Shawn O. Pearce | 43c3d9e | 2009-03-04 14:26:50 -0800 | [diff] [blame] | 25 | helpUsage = """ |
Sean McAllister | d38300c | 2020-02-20 13:49:01 -0700 | [diff] [blame] | 26 | %prog [-o {-|NAME.xml}] [-m MANIFEST.xml] [-r] |
Shawn O. Pearce | 43c3d9e | 2009-03-04 14:26:50 -0800 | [diff] [blame] | 27 | """ |
| 28 | _helpDescription = """ |
Shawn O. Pearce | c7a4eef | 2009-03-05 10:32:38 -0800 | [diff] [blame] | 29 | |
| 30 | With the -o option, exports the current manifest for inspection. |
Mike Frysinger | 4e1fc10 | 2020-09-06 14:42:47 -0400 | [diff] [blame] | 31 | The manifest and (if present) local_manifests/ are combined |
Shawn O. Pearce | c7a4eef | 2009-03-05 10:32:38 -0800 | [diff] [blame] | 32 | together to produce a single manifest file. This file can be stored |
| 33 | in a Git repository for use during future 'repo init' invocations. |
| 34 | |
Sean McAllister | 74e8ed4 | 2020-04-15 12:24:43 -0600 | [diff] [blame] | 35 | The -r option can be used to generate a manifest file with project |
| 36 | revisions set to the current commit hash. These are known as |
| 37 | "revision locked manifests", as they don't follow a particular branch. |
| 38 | In this case, the 'upstream' attribute is set to the ref we were on |
Sean McAllister | af908cb | 2020-04-20 08:41:58 -0600 | [diff] [blame] | 39 | when the manifest was generated. The 'dest-branch' attribute is set |
| 40 | to indicate the remote ref to push changes to via 'repo upload'. |
Shawn O. Pearce | 43c3d9e | 2009-03-04 14:26:50 -0800 | [diff] [blame] | 41 | """ |
| 42 | |
| 43 | @property |
| 44 | def helpDescription(self): |
David Pursehouse | 8a68ff9 | 2012-09-24 12:15:13 +0900 | [diff] [blame] | 45 | helptext = self._helpDescription + '\n' |
Shawn O. Pearce | 43c3d9e | 2009-03-04 14:26:50 -0800 | [diff] [blame] | 46 | r = os.path.dirname(__file__) |
| 47 | r = os.path.dirname(r) |
Mike Frysinger | 3164d40 | 2019-11-11 05:40:22 -0500 | [diff] [blame] | 48 | with open(os.path.join(r, 'docs', 'manifest-format.md')) as fd: |
| 49 | for line in fd: |
| 50 | helptext += line |
David Pursehouse | 8a68ff9 | 2012-09-24 12:15:13 +0900 | [diff] [blame] | 51 | return helptext |
Shawn O. Pearce | 43c3d9e | 2009-03-04 14:26:50 -0800 | [diff] [blame] | 52 | |
Shawn O. Pearce | c7a4eef | 2009-03-05 10:32:38 -0800 | [diff] [blame] | 53 | def _Options(self, p): |
| 54 | p.add_option('-r', '--revision-as-HEAD', |
| 55 | dest='peg_rev', action='store_true', |
Mike Frysinger | c177f94 | 2021-05-04 08:06:36 -0400 | [diff] [blame^] | 56 | help='save revisions as current HEAD') |
Sean McAllister | d38300c | 2020-02-20 13:49:01 -0700 | [diff] [blame] | 57 | p.add_option('-m', '--manifest-name', |
| 58 | help='temporary manifest to use for this sync', metavar='NAME.xml') |
Brian Harring | 14a6674 | 2012-09-28 20:21:57 -0700 | [diff] [blame] | 59 | p.add_option('--suppress-upstream-revision', dest='peg_rev_upstream', |
| 60 | default=True, action='store_false', |
Mike Frysinger | c177f94 | 2021-05-04 08:06:36 -0400 | [diff] [blame^] | 61 | help='if in -r mode, do not write the upstream field ' |
| 62 | '(only of use if the branch names for a sha1 manifest are ' |
| 63 | 'sensitive)') |
Sean McAllister | af908cb | 2020-04-20 08:41:58 -0600 | [diff] [blame] | 64 | p.add_option('--suppress-dest-branch', dest='peg_rev_dest_branch', |
| 65 | default=True, action='store_false', |
Mike Frysinger | c177f94 | 2021-05-04 08:06:36 -0400 | [diff] [blame^] | 66 | help='if in -r mode, do not write the dest-branch field ' |
| 67 | '(only of use if the branch names for a sha1 manifest are ' |
| 68 | 'sensitive)') |
Mike Frysinger | 23411d3 | 2020-09-02 04:31:10 -0400 | [diff] [blame] | 69 | p.add_option('--json', default=False, action='store_true', |
Mike Frysinger | c177f94 | 2021-05-04 08:06:36 -0400 | [diff] [blame^] | 70 | help='output manifest in JSON format (experimental)') |
Mike Frysinger | 23411d3 | 2020-09-02 04:31:10 -0400 | [diff] [blame] | 71 | p.add_option('--pretty', default=False, action='store_true', |
Mike Frysinger | c177f94 | 2021-05-04 08:06:36 -0400 | [diff] [blame^] | 72 | help='format output for humans to read') |
Shawn O. Pearce | c7a4eef | 2009-03-05 10:32:38 -0800 | [diff] [blame] | 73 | p.add_option('-o', '--output-file', |
| 74 | dest='output_file', |
Conley Owens | 918ff85 | 2012-08-07 10:44:01 -0700 | [diff] [blame] | 75 | default='-', |
Mike Frysinger | c177f94 | 2021-05-04 08:06:36 -0400 | [diff] [blame^] | 76 | help='file to save the manifest to', |
Shawn O. Pearce | c7a4eef | 2009-03-05 10:32:38 -0800 | [diff] [blame] | 77 | metavar='-|NAME.xml') |
| 78 | |
| 79 | def _Output(self, opt): |
Sean McAllister | d38300c | 2020-02-20 13:49:01 -0700 | [diff] [blame] | 80 | # If alternate manifest is specified, override the manifest file that we're using. |
| 81 | if opt.manifest_name: |
| 82 | self.manifest.Override(opt.manifest_name, False) |
| 83 | |
Shawn O. Pearce | c7a4eef | 2009-03-05 10:32:38 -0800 | [diff] [blame] | 84 | if opt.output_file == '-': |
| 85 | fd = sys.stdout |
| 86 | else: |
| 87 | fd = open(opt.output_file, 'w') |
Mike Frysinger | 23411d3 | 2020-09-02 04:31:10 -0400 | [diff] [blame] | 88 | if opt.json: |
| 89 | print('warning: --json is experimental!', file=sys.stderr) |
| 90 | doc = self.manifest.ToDict(peg_rev=opt.peg_rev, |
| 91 | peg_rev_upstream=opt.peg_rev_upstream, |
| 92 | peg_rev_dest_branch=opt.peg_rev_dest_branch) |
| 93 | |
| 94 | json_settings = { |
| 95 | # JSON style guide says Uunicode characters are fully allowed. |
| 96 | 'ensure_ascii': False, |
| 97 | # We use 2 space indent to match JSON style guide. |
| 98 | 'indent': 2 if opt.pretty else None, |
| 99 | 'separators': (',', ': ') if opt.pretty else (',', ':'), |
| 100 | 'sort_keys': True, |
| 101 | } |
| 102 | fd.write(json.dumps(doc, **json_settings)) |
| 103 | else: |
| 104 | self.manifest.Save(fd, |
| 105 | peg_rev=opt.peg_rev, |
| 106 | peg_rev_upstream=opt.peg_rev_upstream, |
| 107 | peg_rev_dest_branch=opt.peg_rev_dest_branch) |
Shawn O. Pearce | c7a4eef | 2009-03-05 10:32:38 -0800 | [diff] [blame] | 108 | fd.close() |
| 109 | if opt.output_file != '-': |
Sarah Owens | cecd1d8 | 2012-11-01 22:59:27 -0700 | [diff] [blame] | 110 | print('Saved manifest to %s' % opt.output_file, file=sys.stderr) |
Shawn O. Pearce | c7a4eef | 2009-03-05 10:32:38 -0800 | [diff] [blame] | 111 | |
Mike Frysinger | ae6cb08 | 2019-08-27 01:10:59 -0400 | [diff] [blame] | 112 | def ValidateOptions(self, opt, args): |
Shawn O. Pearce | c7a4eef | 2009-03-05 10:32:38 -0800 | [diff] [blame] | 113 | if args: |
| 114 | self.Usage() |
| 115 | |
Mike Frysinger | ae6cb08 | 2019-08-27 01:10:59 -0400 | [diff] [blame] | 116 | def Execute(self, opt, args): |
| 117 | self._Output(opt) |