-
Notifications
You must be signed in to change notification settings - Fork 1
/
cmds.py
1684 lines (1504 loc) · 66.7 KB
/
cmds.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# __init__.py -- The plugin for bzr
# Copyright (C) 2005 Jamie Wilkinson <[email protected]>
# 2006, 2007 James Westby <[email protected]>
# 2007 Reinhard Tartler <[email protected]>
# 2008-2011 Canonical Ltd.
#
# This file is part of breezy-debian.
#
# bzr-builddeb is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# bzr-builddeb is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with bzr-builddeb; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#
import os
import shutil
import tempfile
from typing import Optional
from ... import (
urlutils,
)
from ...branch import Branch
from ...controldir import (
ControlDir,
NoColocatedBranchSupport,
)
from ...commands import Command
from ...errors import (
BzrCommandError,
NotBranchError,
NotLocalUrl,
NoWorkingTree,
)
from ...transport import (
FileExists,
NoSuchFile,
)
from ...option import Option
from ...trace import mutter, note, warning
from ...transport import get_transport
from ...workingtree import WorkingTree
from . import (
default_build_dir,
default_orig_dir,
default_result_dir,
gettext,
)
from .config import (
BUILD_TYPE_MERGE,
BUILD_TYPE_NATIVE,
BUILD_TYPE_SPLIT,
)
from .util import (
debuild_config,
)
dont_purge_opt = Option(
'dont-purge',
help="Don't purge the build directory after building.")
result_opt = Option(
'result-dir',
help="Directory in which to place the resulting package files.", type=str,
argname="DIRECTORY")
builder_opt = Option(
'builder',
help="Command to build the package.", type=str,
argname="BUILDER")
merge_opt = Option(
'merge',
help='Merge the debian part of the source in to the upstream tarball.')
split_opt = Option(
'split',
help="Automatically create an .orig.tar.gz from a full source branch.")
build_dir_opt = Option(
'build-dir',
help="The dir to use for building.", type=str)
orig_dir_opt = Option(
'orig-dir',
help="Directory containing the .orig.tar.gz files. For use when only "
"debian/ is versioned.", type=str,
argname="DIRECTORY")
native_opt = Option(
'native',
help="Build a native package.")
export_upstream_opt = Option(
'export-upstream',
help="Create the .orig.tar.gz from specified bzr branch before building.",
type=str, argname="BRANCH")
export_upstream_revision_opt = Option(
'export-upstream-revision',
help="Select the upstream revision that will be exported.",
type=str, argname="REVISION")
apt_repository_opts = [Option(
'apt-repository',
help='Apt repository to attempt to fetch from',
type=str), Option(
'apt-repository-key',
help='Apt repository key to use for validation',
type=str)]
class StrictBuildFailed(BzrCommandError):
_fmt = ("Build refused because there are unknown files in the tree. "
"To list all known files, run 'bzr unknowns'.")
def _check_tree(tree, subpath, strict=False):
if strict:
for unknown in tree.unknowns():
raise StrictBuildFailed()
if len(tree.conflicts()) > 0:
raise BzrCommandError(
"There are conflicts in the working tree. "
"You must resolve these before building.")
def _check_uncommitted(tree, subpath):
if tree.changes_from(tree.basis_tree()).has_changed():
raise BzrCommandError(gettext(
"There are uncommitted "
"changes in the working tree. You must commit "
"before using this command"))
def _get_changelog_info(tree, subpath, last_version=None, package=None,
distribution=None):
from .util import (
find_changelog,
find_last_distribution,
lookup_distribution,
MissingChangelogError,
)
DEFAULT_FALLBACK_DISTRIBUTION = "debian"
current_version = last_version
try:
(changelog, top_level) = find_changelog(
tree, subpath, merge=False, max_blocks=2)
except MissingChangelogError:
top_level = False
changelog = None
if distribution is None:
distribution = DEFAULT_FALLBACK_DISTRIBUTION
note(gettext("No distribution specified, and no changelog, "
"assuming '%s'"), distribution)
else:
if last_version is None:
current_version = changelog.version.upstream_version
if package is None:
package = changelog.package
if distribution is None:
distribution = find_last_distribution(changelog)
if distribution is not None:
note(gettext("Using distribution %s") % distribution)
else:
distribution = DEFAULT_FALLBACK_DISTRIBUTION
note(gettext("No distribution specified, and no previous "
"distribution in changelog. Assuming '%s'"),
distribution)
distribution = distribution.lower()
distribution_name = lookup_distribution(distribution)
if distribution_name is None:
raise BzrCommandError(
gettext("Unknown target distribution: %s") % distribution)
return (current_version, package, distribution, distribution_name,
changelog, top_level)
def _get_upstream_branch_source(
export_upstream, export_upstream_revision, config, version,
other_repository=None, guess_upstream_url=None):
if export_upstream is None and config.upstream_branch:
export_upstream = config.upstream_branch
if export_upstream is None:
if guess_upstream_url is None:
return None
export_upstream = guess_upstream_url
from .upstream.branch import (
LazyUpstreamBranchSource,
)
upstream_revision_map = {}
if export_upstream_revision:
upstream_revision_map[version] = export_upstream_revision
return LazyUpstreamBranchSource(
export_upstream, config=config,
upstream_revision_map=upstream_revision_map,
other_repository=other_repository)
def _get_upstream_sources(local_tree, subpath, packaging_branch,
build_type, config, upstream_version, top_level,
export_upstream=None,
export_upstream_revision=None,
trust_package=True,
guess_upstream_branch_url=False,
apt=None, skip_signatures=False):
from .upstream import (
AptSource,
SelfSplitSource,
DirectoryScanSource,
)
from .upstream.uscan import (
UScanSource,
NoWatchFile,
)
from .upstream.pristinetar import (
get_pristine_tar_source,
)
yield AptSource(apt=apt)
yield get_pristine_tar_source(local_tree, packaging_branch)
try:
yield UScanSource.from_tree(
local_tree, subpath, top_level, skip_signatures=skip_signatures)
except NoWatchFile:
pass
if guess_upstream_branch_url:
try:
from upstream_ontologist.guess import (
guess_upstream_metadata,
)
except ModuleNotFoundError:
guess_upstream_url = None
else:
def guess_upstream_url():
guessed_upstream_metadata = guess_upstream_metadata(
local_tree.abspath(subpath), trust_package=trust_package,
net_access=True, consult_external_directory=False)
return guessed_upstream_metadata.get('Repository')
else:
guess_upstream_url = None
upstream_branch_source = _get_upstream_branch_source(
export_upstream, export_upstream_revision, config,
upstream_version, other_repository=packaging_branch.repository,
guess_upstream_url=guess_upstream_url)
if upstream_branch_source:
yield upstream_branch_source
if build_type == BUILD_TYPE_SPLIT:
yield SelfSplitSource(local_tree)
yield DirectoryScanSource('..')
def _get_distiller(
tree, subpath, packaging_branch, changelog, build_type, config,
contains_upstream_source=True, top_level=False,
orig_dir=default_orig_dir, use_existing=False,
export_upstream=None, export_upstream_revision=None,
guess_upstream_branch_url=False,
apt=None, skip_signatures=False):
from .util import (
guess_build_type,
)
from .upstream import (
UpstreamProvider,
)
from .source_distiller import (
FullSourceDistiller,
MergeModeDistiller,
NativeSourceDistiller,
DebcargoDistiller,
)
if build_type is None:
build_type = config.build_type
if build_type is None:
build_type = guess_build_type(
tree, changelog.version, subpath, contains_upstream_source)
note(gettext("Building package in %s mode") % build_type)
upstream_sources = list(_get_upstream_sources(
tree, subpath, packaging_branch, build_type=build_type,
config=config, upstream_version=changelog.version.upstream_version,
top_level=top_level, export_upstream=export_upstream,
export_upstream_revision=export_upstream_revision,
guess_upstream_branch_url=guess_upstream_branch_url,
apt=apt, skip_signatures=skip_signatures))
upstream_provider = UpstreamProvider(
changelog.package, changelog.version.upstream_version, orig_dir,
upstream_sources)
# Turn this into a build type?
if tree.has_filename(os.path.join(subpath, 'debian/debcargo.toml')):
return DebcargoDistiller(
tree, subpath, top_level=top_level,
use_existing=use_existing)
if build_type == BUILD_TYPE_MERGE:
return MergeModeDistiller(
tree, subpath, upstream_provider, top_level=top_level,
use_existing=use_existing)
elif build_type == BUILD_TYPE_NATIVE:
return NativeSourceDistiller(tree, subpath, use_existing=use_existing)
else:
return FullSourceDistiller(
tree, subpath, upstream_provider, use_existing=use_existing)
class cmd_builddeb(Command):
"""Builds a Debian package from a branch.
If BRANCH is specified it is assumed that the branch you wish to build is
located there. If it is not specified then the current directory is used.
By default, if a working tree is found, it is used to build. Otherwise the
last committed revision found in the branch is used. To force building the
last committed revision use --revision -1. You can also specify any other
revision with the --revision option.
If you only wish to export the package, and not build it (especially useful
for merge mode), use --export-only.
To leave the build directory when the build is completed use --dont-purge.
Specify the command to use when building using the --builder option, by
default "debuild" is used. It can be overriden by setting the "builder"
variable in you configuration. You can specify extra options to build with
by adding them to the end of the command, after using "--" to indicate the
end of the options to builddeb itself. The builder that you specify must
accept the options you provide at the end of its command line.
You can also specify directories to use for different things. --build-dir
is the directory to build the packages beneath, which defaults to
'../build-area'. '--orig-dir' specifies the directory that contains the
.orig.tar.gz files , which defaults to '..'. '--result-dir' specifies where
the resulting package files should be placed, which defaults to '..'.
--result-dir will have problems if you use a build command that places
the results in a different directory.
The --reuse option will be useful if you are in merge mode, and the
upstream tarball is very large. It attempts to reuse a build directory from
an earlier build. It will fail if one doesn't exist, but you can create one
by using --export-only.
--quick allows you to define a quick-builder in your configuration files,
which will be used when this option is passed. It defaults to 'fakeroot
debian/rules binary'. It is overriden if --builder is passed. Using this
and --reuse allows for fast rebuilds.
"""
export_only_opt = Option('export-only', help="Export only, don't build.",
short_name='e')
use_existing_opt = Option('use-existing',
help="Use an existing build directory.")
quick_opt = Option('quick', help="Quickly build the package, uses "
"quick-builder, which defaults to \"fakeroot "
"debian/rules binary\".")
reuse_opt = Option('reuse', help="Try to avoid exporting too much on each "
"build. Only works in merge mode; it saves unpacking "
"the upstream tarball each time. Implies --dont-purge "
"and --use-existing.")
source_opt = Option('source', help="Build a source package.",
short_name='S')
strict_opt = Option(
'strict',
help='Refuse to build if there are unknown files in'
' the working tree, --no-strict disables the check.')
package_merge_opt = Option(
'package-merge', help="Build using the "
"appropriate -v and -sa options for merging in the changes from "
"another source.")
guess_upstream_branch_url_opt = Option(
'guess-upstream-branch-url', help=(
'Guess upstream branch URL if unknown '
'(requires upstream-ontologist)'))
takes_args = ['branch_or_build_options*']
aliases = ['bd', 'debuild']
takes_options = [
export_only_opt, dont_purge_opt, use_existing_opt, result_opt,
builder_opt, merge_opt, build_dir_opt, orig_dir_opt, split_opt,
export_upstream_opt, export_upstream_revision_opt, quick_opt,
reuse_opt, native_opt, source_opt, 'revision', strict_opt,
package_merge_opt, guess_upstream_branch_url_opt,
] + apt_repository_opts
def _get_tree_and_branch(self, location):
if location is None:
location = "."
transport = get_transport(location)
try:
transport.local_abspath('.')
except NotLocalUrl:
is_local = False
else:
is_local = True
controldir, relpath = ControlDir.open_containing_from_transport(
transport)
tree, branch = controldir._get_tree_branch()
return tree, branch, is_local, controldir.user_url, relpath
def _get_build_tree(self, revision, tree, branch):
if revision is None and tree is not None:
note(gettext("Building using working tree"))
else:
if revision is None:
revid = branch.last_revision()
elif len(revision) == 1:
revid = revision[0].in_history(branch).rev_id
else:
raise BzrCommandError(gettext(
'bzr builddeb --revision takes exactly one '
'revision specifier.'))
note(gettext("Building branch from revision %s"), revid)
tree = branch.repository.revision_tree(revid)
return tree
def _build_type(self, merge, native, split):
if merge:
return BUILD_TYPE_MERGE
if native:
return BUILD_TYPE_NATIVE
if split:
return BUILD_TYPE_SPLIT
return None
def _get_build_command(self, config, builder, quick, build_options):
if builder is None:
if quick:
builder = config.quick_builder
if builder is None:
builder = "fakeroot debian/rules binary"
else:
builder = config.builder
if builder is None:
builder = "debuild"
if build_options:
builder += " " + " ".join(build_options)
return builder
def _get_dirs(self, config, location, is_local, result_dir, build_dir,
orig_dir):
def _get_dir(supplied, if_local, if_not):
if supplied is None:
if is_local:
supplied = if_local
else:
supplied = if_not
if supplied is not None:
if is_local:
supplied = os.path.join(
urlutils.local_path_from_url(location),
supplied)
supplied = os.path.realpath(supplied)
return supplied
result_dir = _get_dir(
result_dir, config.result_dir, config.user_result_dir)
build_dir = _get_dir(
build_dir, config.build_dir or default_build_dir,
config.user_build_dir or 'build-area')
orig_dir = _get_dir(
orig_dir, config.orig_dir or default_orig_dir,
config.user_orig_dir or 'build-area')
return result_dir, build_dir, orig_dir
def _branch_and_build_options(self, branch_or_build_options_list,
source=False):
branch = None
build_options = []
source_opt = False
if branch_or_build_options_list is not None:
for opt in branch_or_build_options_list:
if opt.startswith("-") or branch is not None:
build_options.append(opt)
if opt == "-S" or opt == "--source":
source_opt = True
else:
branch = opt
if source and not source_opt:
build_options.append("-S")
if source_opt:
source = True
return branch, build_options, source
def run(self, branch_or_build_options_list=None, verbose=False,
export_only=False, dont_purge=False, use_existing=False,
result_dir=None, builder=None, merge=None, build_dir=None,
export_upstream=None, export_upstream_revision=None,
orig_dir=None, split=None,
quick=False, reuse=False, native=None,
source=False, revision=None, package_merge=None,
strict=False, guess_upstream_branch_url=False,
apt_repository=None, apt_repository_key=None):
from debian.changelog import ChangelogParseError
from .builder import DebBuild
from .config import UpstreamMetadataSyntaxError
from .hooks import run_hook
from .source_distiller import DebcargoError
from .util import (
NoPreviousUpload,
dget_changes,
find_changelog,
find_previous_upload,
tree_contains_upstream_source,
find_changes_files,
)
location, build_options, source = self._branch_and_build_options(
branch_or_build_options_list, source)
tree, branch, is_local, location, subpath = self._get_tree_and_branch(
location)
tree = self._get_build_tree(revision, tree, branch)
_check_tree(tree, subpath, strict=strict)
if apt_repository is not None:
from .apt_repo import RemoteApt
apt = RemoteApt.from_string(apt_repository, apt_repository_key)
else:
apt = None
with tree.lock_read():
try:
config = debuild_config(tree, subpath)
except UpstreamMetadataSyntaxError as e:
raise BzrCommandError(
gettext('Unable to parse upstream metadata file %s: %s')
% (e.path, e.error)) from e
if reuse:
note(gettext("Reusing existing build dir"))
dont_purge = True
use_existing = True
build_type = self._build_type(merge, native, split)
contains_upstream_source = tree_contains_upstream_source(
tree, subpath)
try:
(changelog, top_level) = find_changelog(
tree, subpath, merge=not contains_upstream_source)
except ChangelogParseError as e:
raise BzrCommandError(
gettext("Unable to parse changelog: %s") %
e) from e
if package_merge:
try:
prev_version = find_previous_upload(
tree, subpath, not contains_upstream_source)
except NoPreviousUpload:
prev_version = None
if prev_version is None:
build_options.extend(["-sa", "-v0"])
else:
build_options.append("-v%s" % str(prev_version))
if (prev_version.upstream_version
!= changelog.version.upstream_version
or prev_version.epoch != changelog.version.epoch):
build_options.append("-sa")
build_cmd = self._get_build_command(
config, builder, quick, build_options)
result_dir, build_dir, orig_dir = self._get_dirs(
config, location or ".", is_local, result_dir, build_dir,
orig_dir)
distiller = _get_distiller(
tree, subpath, branch, build_type=build_type, config=config,
changelog=changelog,
contains_upstream_source=contains_upstream_source,
orig_dir=orig_dir, use_existing=use_existing,
top_level=top_level, export_upstream=export_upstream,
export_upstream_revision=export_upstream_revision,
guess_upstream_branch_url=guess_upstream_branch_url,
apt=apt)
build_source_dir = os.path.join(
build_dir,
"{}-{}".format(
changelog.package, changelog.version.upstream_version))
builder = DebBuild(
distiller, build_source_dir, build_cmd,
use_existing=use_existing)
builder.prepare()
run_hook(tree, 'pre-export', config)
try:
builder.export()
except DebcargoError as e:
raise BzrCommandError(str(e)) from e
if not export_only:
run_hook(tree, 'pre-build', config, wd=build_source_dir)
builder.build()
run_hook(tree, 'post-build', config, wd=build_source_dir)
if not dont_purge:
builder.clean()
changes_paths = []
for kind, entry in find_changes_files(
build_dir, changelog.package, changelog.version):
changes_paths.append(entry.path)
if not changes_paths:
if result_dir is not None:
raise BzrCommandError(
"Could not find the .changes "
"file from the build: %s" % build_dir)
return
if is_local:
target_dir = result_dir or default_result_dir
target_dir = os.path.join(
urlutils.local_path_from_url(location),
target_dir)
else:
target_dir = "."
if not os.path.exists(target_dir):
os.makedirs(target_dir)
for changes_path in changes_paths:
dget_changes(changes_path, target_dir)
class cmd_get_orig_source(Command):
"""Gets the upstream tar file for the packaging branch."""
directory_opt = Option(
'directory',
help='Directory from which to retrieve the packaging data',
short_name='d', type=str)
takes_options = [directory_opt] + apt_repository_opts
takes_args = ["version?"]
def run(self, directory='.', version=None, apt_repository=None,
apt_repository_key=None):
from .upstream import (
AptSource,
UpstreamProvider,
)
from .upstream.uscan import (
UScanSource,
NoWatchFile,
)
from .upstream.pristinetar import (
get_pristine_tar_source,
)
from .util import (
find_changelog,
)
tree, subpath = WorkingTree.open_containing(directory)
config = debuild_config(tree, subpath)
(changelog, larstiq) = find_changelog(tree, subpath, merge=True)
orig_dir = config.orig_dir
if orig_dir is None:
orig_dir = default_orig_dir
if version is None:
version = changelog.version.upstream_version
if apt_repository is not None:
from .apt_repo import RemoteApt
apt = RemoteApt.from_string(apt_repository, apt_repository_key)
else:
apt = None
upstream_sources = [
get_pristine_tar_source(tree, tree.branch),
AptSource(apt)]
try:
uscan_source = UScanSource.from_tree(tree, subpath, larstiq)
except NoWatchFile:
pass
else:
upstream_sources.append(uscan_source)
upstream_provider = UpstreamProvider(
changelog.package,
str(version), orig_dir,
upstream_sources)
result = upstream_provider.provide(orig_dir)
for tar, component in result:
note(gettext("Tar now in %s") % tar)
class cmd_merge_upstream(Command):
"""Merges a new upstream version into the current branch.
Takes a new upstream version and merges it in to your branch, so that your
packaging changes are applied to the new version.
You must supply the source to import from, and in some cases
the version number of the new release. The source can be a .tar.gz, .tar,
.tar.bz2, .tar.xz, .tgz or .zip archive, a directory or a branch. The
source may also be a remote file described by a URL.
In most situations the version can be guessed from the upstream source.
If the upstream version can not be guessed or if it is guessed
incorrectly then the version number can be specified with --version.
The distribution this version is targetted at can be specified with
--distribution. This will be used to guess the version number suffix
that you want, but you can always correct it in the resulting
debian/changelog.
If there is no debian changelog in the branch to retrieve the package
name from then you must pass the --package option. If this version
will change the name of the source package then you can use this option
to set the new name.
examples::
bzr merge-upstream --version 0.2 \
http://example.org/releases/scruff-0.2.tar.gz
If you are merging a branch as well as the tarball then you can
specify the branch after the tarball, along with -r to specify the
revision of that branch to take::
bzr merge-upstream --version 0.2 \
http://example.org/releases/scruff-0.2.tar.gz \
http://scruff.org/bzr/scruff.dev -r tag:0.2
If there is no upstream release tarball, and you want bzr-builddeb to
create the tarball for you::
bzr merge-upstream --version 0.2 http://scruff.org/bzr/scruff.dev
Note that the created tarball is just the same as the contents of
the branch at the specified revision. If you wish to have something
different, for instance the results of running "make dist", then you
should create the tarball first, and pass it to the command as in
the second example.
"""
takes_args = ['location?', 'upstream_branch?']
aliases = ['mu']
package_opt = Option('package', help="The name of the source package.",
type=str)
version_opt = Option(
'version',
help="The upstream version number of this release, for example "
"\"0.2\".", type=str)
distribution_opt = Option(
'distribution', help="The distribution that "
"this release is targetted at.", type=str)
directory_opt = Option('directory',
help='Working tree into which to merge.',
short_name='d', type=str)
last_version_opt = Option('last-version',
help='The full version of the last time '
'upstream was merged.', type=str)
force_opt = Option('force',
help=('Force a merge even if the upstream branch '
'has not changed.'))
snapshot_opt = Option(
'snapshot', help="Merge a snapshot from the "
"upstream branch rather than a new upstream release.")
release_opt = Option(
'release', help='Merge a release from the upstream branch.')
force_pristine_tar_opt = Option(
'force-pristine-tar', help=(
'Force the use of pristine-tar, even if no '
'pristine-tar branch exists'))
dist_command_opt = Option(
'dist-command', type=str,
help='Command to run for creating an upstream tarball from a '
'VCS snapshot.')
guess_upstream_branch_url_opt = Option(
'guess-upstream-branch-url', help=(
'Guess upstream branch URL if unknown '
'(requires upstream-ontologist)'))
takes_options = [
package_opt, version_opt,
distribution_opt, directory_opt, last_version_opt,
force_opt, 'revision', 'merge-type',
snapshot_opt, force_pristine_tar_opt,
dist_command_opt, guess_upstream_branch_url_opt, release_opt,
Option('skip-signatures',
help=('Allow signatures for e.g. upstream tarball '
'to be missing'))]
def run(self, location: Optional[str] = None,
upstream_branch: Optional[str] = None,
version: Optional[str] = None,
distribution: Optional[str] = None, package: Optional[str] = None,
directory: str = ".", revision=None, merge_type=None,
last_version: Optional[str] = None,
force: Optional[bool] = None, snapshot: Optional[bool] = None,
release: Optional[bool] = None,
force_pristine_tar: bool = False,
dist_command: Optional[str] = None,
guess_upstream_branch_url: bool = False,
skip_signatures: bool = False):
from debian.changelog import Version
from .hooks import run_hook
from .merge_upstream import (
changelog_add_new_version,
do_merge,
get_tarballs,
)
from .upstream import (
PackageVersionNotPresent,
TarfileSource,
)
from .upstream.branch import (
PreviousVersionTagMissing,
UpstreamBranchSource,
run_dist_command,
)
from .upstream.uscan import (
UScanSource,
NoWatchFile,
)
from .util import (
detect_version_kind,
guess_build_type,
get_files_excluded,
tree_contains_upstream_source,
)
tree, subpath = WorkingTree.open_containing(directory)
with tree.lock_write():
_check_uncommitted(tree, subpath)
config = debuild_config(tree, subpath)
(current_version, package, distribution, distribution_name,
changelog, top_level) = _get_changelog_info(
tree, subpath, last_version, package, distribution)
if package is None:
raise BzrCommandError(
"You did not specify --package, and "
"there is no changelog from which to determine the "
"package name, which is needed to know the name to "
"give the .orig.tar.gz. Please specify --package.")
if snapshot is None and release is None:
if current_version is not None:
version_kind = detect_version_kind(current_version)
else:
version_kind = None
elif snapshot is not None and release is not None:
raise BzrCommandError(
'--release and --snapshot are incompatible')
elif snapshot:
version_kind = "snapshot"
elif release:
version_kind = "release"
if version_kind is None:
version_kind = "release"
try:
files_excluded = get_files_excluded(tree, subpath, top_level)
except NoSuchFile as e:
mutter('Copyright file not found: %s', e)
files_excluded = []
contains_upstream_source = tree_contains_upstream_source(
tree, subpath)
if changelog is None:
changelog_version = None
else:
changelog_version = changelog.version
build_type = config.build_type
if build_type is None:
build_type = guess_build_type(
tree, changelog_version, subpath, contains_upstream_source)
need_upstream_tarball = (build_type != BUILD_TYPE_MERGE)
if build_type == BUILD_TYPE_NATIVE:
raise BzrCommandError(gettext(
"Merge upstream in native mode is not supported."))
if upstream_branch is not None:
upstream_branch = Branch.open(upstream_branch)
elif location is not None and not os.path.isfile(location):
try:
upstream_branch = Branch.open(location)
except NotBranchError:
upstream_branch = None
elif (upstream_branch is None
and config.upstream_branch is not None):
note(gettext("Using upstream branch %s (from configuration)"),
config.upstream_branch)
upstream_branch = Branch.open(config.upstream_branch)
elif upstream_branch is None and guess_upstream_branch_url:
try:
from upstream_ontologist.guess import (
guess_upstream_metadata,
)
except ModuleNotFoundError:
warning(
'upstream-ontologist not available, '
'not guess upstream branch URL')
upstream_branch = None
else:
guessed_upstream_metadata = guess_upstream_metadata(
tree.abspath(subpath), trust_package=False,
net_access=True, consult_external_directory=False)
guessed_repo = guessed_upstream_metadata.get('Repository')
if guessed_repo:
note('Opening upstream-ontologist provided branch %s',
guessed_repo)
upstream_branch = Branch.open(guessed_repo)
else:
upstream_branch = None
if dist_command:
def create_dist(
tree, package, version, target_dir, subpath=''):
return run_dist_command(
tree, package, version, target_dir, dist_command,
subpath=subpath)
else:
create_dist = None
if upstream_branch is not None:
upstream_branch_source = UpstreamBranchSource.from_branch(
upstream_branch, config=config, local_dir=tree.controldir,
create_dist=create_dist, version_kind=version_kind)
else:
upstream_branch_source = None
if location is not None:
try:
primary_upstream_source = UpstreamBranchSource.from_branch(
Branch.open(location), config=config,
local_dir=tree.controldir,
create_dist=create_dist, version_kind=version_kind)
except NotBranchError:
primary_upstream_source = TarfileSource(location, version)
else:
if snapshot:
if upstream_branch_source is None:
raise BzrCommandError(gettext(
"--snapshot requires an upstream branch source"))
primary_upstream_source = upstream_branch_source
else:
try:
primary_upstream_source = UScanSource.from_tree(
tree, subpath, top_level,
skip_signatures=skip_signatures)
except NoWatchFile as e:
if upstream_branch_source is None:
raise BzrCommandError(gettext(
"no upstream source location known; "
"add watch file or specify "
"upstream repository?")) from e
primary_upstream_source = upstream_branch_source
if revision is not None:
if upstream_branch is None:
raise BzrCommandError(gettext(
"--revision can only be "
"used with a valid upstream branch"))
if len(revision) > 1:
raise BzrCommandError(gettext(
"merge-upstream takes only a single --revision"))
upstream_revspec = revision[0]
upstream_revisions = {
None: (upstream_revspec.as_revision_id(upstream_branch),
subpath)}
else:
upstream_revisions = None
if version is None and upstream_revisions is not None:
# Look up the version from the upstream revision
unmangled_version, version = (
upstream_branch_source.get_version(
package, current_version, upstream_revisions[None][0]))
elif version is None and primary_upstream_source is not None:
unmangled_version, version = (
primary_upstream_source.get_latest_version(
package, current_version))
if version is None:
if upstream_branch_source is not None:
raise BzrCommandError(gettext(
"You must specify "
"the version number using --version or specify "
"--snapshot to merge a snapshot from the upstream "
"branch."))
else:
raise BzrCommandError(gettext(
"You must specify the "
"version number using --version."))
note(gettext("Using version string %s."), version)
# Look up the revision id from the version string
if (upstream_revisions is None
and upstream_branch_source is not None):
try:
upstream_revisions = upstream_branch_source\
.version_as_revisions(package, version)
except PackageVersionNotPresent as e:
raise BzrCommandError(
"Version %s can not be found in upstream branch %r. "
"Specify the revision manually using --revision or "
"adjust 'export-upstream-revision' in the "