-
Notifications
You must be signed in to change notification settings - Fork 0
/
boom-0.8-5.6.patch
1930 lines (1838 loc) · 67.1 KB
/
boom-0.8-5.6.patch
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
MANIFEST.in | 2 +-
boom.spec | 74 +++-
boom/__init__.py | 168 +++++++--
boom/bootloader.py | 22 +-
boom/command.py | 119 ++++++-
boom/config.py | 242 +++++++++++++
boom/legacy.py | 374 +++++++++++++++++++++
examples/boom.conf | 8 +
man/man5/boom.5 | 52 +++
man/man8/boom.8 | 120 ++++++-
...94b7b3c8c95cb7d93f75693d2b25f764d-rhel6.profile | 2 +-
tests/command_tests.py | 25 +-
tests/grub/grub.conf | 211 ++++++++++++
13 files changed, 1354 insertions(+), 65 deletions(-)
diff --git a/MANIFEST.in b/MANIFEST.in
index a56ade8..06a542d 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -5,4 +5,4 @@ recursive-include doc *
recursive-include tests/boom *
recursive-include tests/loader *
recursive-include examples *
-recursive-include man/man8 *.8
+recursive-include man/ *
diff --git a/boom.spec b/boom.spec
index f65142d..763dc15 100644
--- a/boom.spec
+++ b/boom.spec
@@ -1,3 +1,8 @@
+%{!?__python2: %global __python2 /usr/bin/python2}
+%{!?py2_build: %global py2_build %{expand: CFLAGS="%{optflags}" %{__python2} setup.py %{?py_setup_args} build --executable="%{__python2} -s"}}
+%{!?py2_install: %global py2_install %{expand: CFLAGS="%{optflags}" %{__python2} setup.py %{?py_setup_args} install -O1 --skip-build --root %{buildroot}}}
+%{!?python2_sitelib: %global python2_sitelib %{python_sitelib}}
+
%if 0%{?rhel}
%global py2_pkgname python-boom
%else
@@ -9,7 +14,7 @@
Name: boom
Version: 0.8
-Release: 1%{?dist}
+Release: 5.6%{?dist}
Summary: %{summary}
Group: Applications/System
@@ -20,13 +25,17 @@ Source0: boom-%{version}.tar.gz
BuildArch: noarch
BuildRequires: python2-devel
+%if 0%{?rhel}
+BuildRequires: python-sphinx
+%else
+BuildRequires: python2-sphinx
+%endif
%if 0%{!?with_python3:1}
BuildRequires: python-setuptools
%endif
%if 0%{?with_python3}
BuildRequires: python2-setuptools
-#BuildRequires: python2-sphinx
BuildRequires: python3-devel
BuildRequires: python3-sphinx
BuildRequires: python3-setuptools
@@ -44,6 +53,24 @@ include this support in both Red Hat Enterprise Linux 7 and Fedora).
Summary: %{summary}
%{?python_provide:%python_provide python2-boom}
+# RHEL6's Python-2.6 does not include the python-argparse module in
+# the main python-libs pacage, and the dbus package is required to
+# provide a machine_id on this release.
+#
+# Since the machine_id is only automatically generated at boot time
+# (and since the machine may not have been rebooted since the package
+# was installed), ensure the file is present by generating it in the
+# %post script.
+%if 0%{?rhel} == 6
+Requires: python-argparse
+Requires: dbus
+
+%post -n %{?py2_pkgname}
+if [ ! -e /var/lib/dbus/machine-id ]; then
+ dbus-uuidgen > /var/lib/dbus/machine-id
+fi
+%endif
+
%description -n %{?py2_pkgname}
Boom is a boot manager for Linux systems using boot loaders that support
the BootLoader Specification for boot entry configuration.
@@ -103,21 +130,32 @@ mkdir -p ${RPM_BUILD_ROOT}/boot/boom/profiles
mkdir -p ${RPM_BUILD_ROOT}/boot/loader/entries
install -d -m 750 ${RPM_BUILD_ROOT}/boot/boom/profiles ${RPM_BUILD_ROOT}
install -d -m 750 ${RPM_BUILD_ROOT}/boot/loader/entries ${RPM_BUILD_ROOT}
+install -m 644 examples/profiles/*.profile ${RPM_BUILD_ROOT}/boot/boom/profiles
+install -m 644 examples/boom.conf ${RPM_BUILD_ROOT}/boot/boom
+
+# Automatically enable legacy bootloader support for RHEL6 builds
+%if 0%{?rhel} == 6
+sed -i 's/enable = False/enable = True/' ${RPM_BUILD_ROOT}/boot/boom/boom.conf
+%endif
mkdir -p ${RPM_BUILD_ROOT}/%{_mandir}/man8
+mkdir -p ${RPM_BUILD_ROOT}/%{_mandir}/man5
install -m 644 man/man8/boom.8 ${RPM_BUILD_ROOT}/%{_mandir}/man8
+install -m 644 man/man5/boom.5 ${RPM_BUILD_ROOT}/%{_mandir}/man5
%check
-%{__python2} setup.py test
+# Test suite currently does not operate in rpmbuild environment
+#%{__python2} setup.py test
-%if 0%{?with_python3}
-%{__python3} setup.py test
-%endif # if with_python3
+#%if 0%{?with_python3}
+#%{__python3} setup.py test
+#%endif # if with_python3
%files -n %{?py2_pkgname}
+%{!?_licensedir:%global license %%doc}
%license COPYING
%doc README.md
-%doc %{_mandir}/man8/boom.*
+%doc %{_mandir}/man*/boom.*
%if 0%{?sphinx_docs}
%doc doc/html/
%endif # if sphinx_docs
@@ -126,13 +164,14 @@ install -m 644 man/man8/boom.8 ${RPM_BUILD_ROOT}/%{_mandir}/man8
%{_bindir}/boom
/etc/grub.d/42_boom
%config(noreplace) /etc/default/boom
+%config(noreplace) /boot/boom/boom.conf
/boot/*
%if 0%{?with_python3}
%files -n python3-boom
%license COPYING
%doc README.md
-%doc %{_mandir}/man8/boom.*
+%doc %{_mandir}/man*/boom.*
%if 0%{?sphinx_docs}
%doc doc/html/
%endif # if sphinx_docs
@@ -144,6 +183,25 @@ install -m 644 man/man8/boom.8 ${RPM_BUILD_ROOT}/%{_mandir}/man8
%endif # if with_python3
%changelog
+* Fri Apr 06 2018 Bryn M. Reeves <bmr@redhat.com> = 0.8-5.6
+- Automatically enable legacy support on RHEL6 builds
+- Add %post snippet to generate machine_id on RHEL6
+- Add additional needed dependencies for RHEL6 builds
+- Print error if machine_id cannot be found
+
+* Tue Mar 27 2018 Bryn M. Reeves <bmr@redhat.com> = 0.8-5.3
+- Include fixes for issue #11 in Copr build
+
+* Fri Mar 16 2018 Bryn M. Reeves <bmr@redhat.com> = 0.8-5.2
+- Add python-2.6 compatibility patch (el6)
+
+* Thu Mar 15 2018 Bryn M. Reeves <bmr@redhat.com> = 0.8-5.1
+- Add built-in profiles to RPM package
+- Bump package release
+
+* Fri Mar 09 2018 Bryn M. Reeves <bmr@redhat.com> = 0.8-5
+- Add boom(5) configuration file man page
+
* Tue Oct 31 2017 Bryn M. Reeves <bmr@redhat.com> = 0.8-1
- Merge spec file changes from mcsontos
- Add boom.8 manual page
diff --git a/boom/__init__.py b/boom/__init__.py
index dfcb4a6..595a342 100644
--- a/boom/__init__.py
+++ b/boom/__init__.py
@@ -37,14 +37,12 @@ __version__ = "0.8"
#: The location of the system ``/boot`` directory.
DEFAULT_BOOT_PATH = "/boot"
-__boot_root = DEFAULT_BOOT_PATH
#: The default path for Boom configuration files.
-_DEFAULT_BOOM_DIR = "boom"
+DEFAULT_BOOM_DIR = "boom"
#: The root directory for Boom configuration files.
-DEFAULT_BOOM_PATH = path_join(DEFAULT_BOOT_PATH, _DEFAULT_BOOM_DIR)
-__boom_root = DEFAULT_BOOM_PATH
+DEFAULT_BOOM_PATH = path_join(DEFAULT_BOOT_PATH, DEFAULT_BOOM_DIR)
#: Kernel version string, in ``uname -r`` format.
FMT_VERSION = "version"
@@ -80,6 +78,7 @@ FORMAT_KEYS = [
]
_MACHINE_ID = "/etc/machine-id"
+_DBUS_MACHINE_ID = "/var/lib/dbus/machine-id"
BOOM_LOG_DEBUG = logging.DEBUG
BOOM_LOG_INFO = logging.INFO
@@ -159,7 +158,7 @@ class BoomLogger(logging.Logger):
:returntype: None
"""
if self.mask_bits & get_debug_mask():
- super(BoomLogger, self).debug(msg, *args, **kwargs)
+ self.debug(msg, *args, **kwargs)
logging.setLoggerClass(BoomLogger)
@@ -185,13 +184,102 @@ def set_debug_mask(mask):
__debug_mask = mask
+class BoomConfig(object):
+ """Class representing boom persistent configuration values.
+ """
+
+ # Initialise members from global defaults
+
+ boot_path = DEFAULT_BOOT_PATH
+ boom_path = DEFAULT_BOOM_PATH
+
+ legacy_enable = False
+ legacy_format = "grub1"
+ legacy_sync = True
+
+ def __str__(self):
+ """Return a string representation of this ``BoomConfig`` in
+ boom.conf (INI) notation.
+ """
+ cstr = ""
+ cstr += '[defaults]\n'
+ cstr += 'boot_path = "%s"\n' % self.boot_path
+ cstr += 'boom_path = "%s"\n\n' % self.boom_path
+
+ cstr += '[legacy]\n'
+ cstr += 'enable = "%s"\n' % self.legacy_enable
+ cstr += 'format = "%s"\n' % self.legacy_format
+ cstr += 'sync = "%s"' % self.legacy_sync
+
+ return cstr
+
+ def __repr__(self):
+ """Return a string representation of this ``BoomConfig`` in
+ BoomConfig initialiser notation.
+ """
+ cstr = ('BoomConfig(boot_path="%s",boom_path="%s",' %
+ (self.boot_path, self.boom_path))
+ cstr += ('enable_legacy="%s",legacy_format="%s",' %
+ (self.legacy_enable, self.legacy_format))
+ cstr += 'legacy_sync="%s")' % self.legacy_sync
+ return cstr
+
+ def __init__(self, boot_path=None, boom_path=None, legacy_enable=None,
+ legacy_format=None, legacy_sync=None):
+ """Initialise a new ``BoomConfig`` object with the supplied
+ configuration values, or defaults for any unset arguments.
+
+ :param boot_path: the path to the system /boot volume
+ :param boom_path: the path to the boom configuration dir
+ :param legacy_enable: enable legacy bootloader support
+ :param legacy_format: the legacy bootlodaer format to write
+ :param legacy_sync: the legacy sync mode
+ """
+ self.boot_path = boot_path or self.boot_path
+ self.boom_path = boom_path or self.boom_path
+ self.legacy_enable = legacy_enable or self.legacy_enable
+ self.legacy_format = legacy_format or self.legacy_format
+ self.legacy_sync = legacy_sync or self.legacy_sync
+
+
+__config = BoomConfig()
+
+def set_boom_config(config):
+ """Set the active configuration to the object ``config`` (which may
+ be any class that includes the ``BoomConfig`` attributes).
+
+ :param config: a configuration object
+ :returns: None
+ :raises: TypeError if ``config`` does not appear to have the
+ correct attributes.
+ """
+ global __config
+
+ def has_value(obj, attr):
+ return hasattr(obj, attr) and getattr(obj, attr) is not None
+
+ if not has_value(config, "boot_path") or not has_value(config, "boom_path"):
+ raise TypeError("config does not appear to be a BoomConfig object.")
+
+ __config = config
+
+
+def get_boom_config():
+ """Return the active ``BoomConfig`` object.
+
+ :returntype: BoomConfig
+ :returns: the active configuration object
+ """
+ return __config
+
+
def get_boot_path():
"""Return the currently configured boot file system path.
:returns: the path to the /boot file system.
:returntype: str
"""
- return __boot_root
+ return __config.boot_path
def get_boom_path():
"""Return the currently configured boom configuration path.
@@ -199,7 +287,7 @@ def get_boom_path():
:returns: the path to the BOOT/boom directory.
:returntype: str
"""
- return __boom_root
+ return __config.boom_path
def set_boot_path(boot_path):
"""Sets the location of the boot file system to ``boot_path``.
@@ -216,53 +304,51 @@ def set_boot_path(boot_path):
:param boot_path: the path to the 'boom/' directory containing
boom profiles and configuration.
- :returns: ``None``
+ :returnsNone: ``None``
:raises: ValueError if ``boot_path`` does not exist.
"""
- global __boot_root, __boom_root
+ global __config
if not isabs(boot_path):
raise ValueError("boot_path must be an absolute path: %s" % boot_path)
if not path_exists(boot_path):
raise ValueError("Path '%s' does not exist" % boot_path)
- __boot_root = boot_path
- _log_debug("Set boot path to: %s" % __boot_root)
- __boom_root = path_join(boot_path, _DEFAULT_BOOM_DIR)
- _log_debug("Set boom path to: %s" % __boom_root)
+ __config.boot_path = boot_path
+ _log_debug("Set boot path to: %s" % boot_path)
+ __config.boom_path = path_join(boot_path, DEFAULT_BOOM_DIR)
+ _log_debug("Set boom path to: %s" % __config.boom_path)
-def set_boom_path(root_path):
+def set_boom_path(boom_path):
"""Set the location of the boom configuration directory.
Set the location of the boom configuration path stored in
- ``__boom_root`` to ``root_path``. ``__boom_root`` defaults to the
+ the active configuration to ``boom_path``. This defaults to the
'boom/' sub-directory in the boot file system specified by
- ``__boot_root``: this may be overridden by calling this function
- with a different path.
-
- Paths must be set before importing any other boom API module:
- changes are not automatically propagated to sub-modules.
+ ``config.boot_path``: this may be overridden by calling this
+ function with a different path.
- :param root_path: the path to the 'boom/' directory containing
+ :param boom_path: the path to the 'boom/' directory containing
boom profiles and configuration.
:returns: ``None``
- :raises: ValueError if ``root_path`` does not exist.
+ :raises: ValueError if ``boom_path`` does not exist.
"""
- global __boot_root, __boom_root
- if isabs(root_path) and not path_exists(root_path):
- raise ValueError("Root path %s does not exist" % root_path)
- elif not path_exists(path_join(__boot_root, root_path)):
- raise ValueError("Root path %s does not exist" % root_path)
+ global __config
+ if isabs(boom_path) and not path_exists(boom_path):
+ raise ValueError("Boom path %s does not exist" % boom_path)
+ elif not path_exists(path_join(__config.boot_path, boom_path)):
+ raise ValueError("Boom path %s does not exist" % boom_path)
- if not isabs(root_path):
- root_path = path_join(__boot_root, root_path)
+ if not isabs(boom_path):
+ boom_path = path_join(__config.boot_bath, boom_path)
- if not path_exists(path_join(root_path, "profiles")):
- raise ValueError("Root path is not a boom configuration path.")
+ if not path_exists(path_join(boom_path, "profiles")):
+ raise ValueError("Path does not contain a valid boom configuration"
+ ": %s" % path_join(boom_path, "profiles"))
- _log_debug("Set boom path to: %s" % _DEFAULT_BOOM_DIR)
- __boom_root = root_path
+ _log_debug("Set boom path to: %s" % DEFAULT_BOOM_DIR)
+ __config.boom_path = boom_path
def _parse_btrfs_subvol(subvol):
@@ -634,7 +720,14 @@ def _get_machine_id():
:returns: The ``machine_id`` as a string
:returntype: str
"""
- with open(_MACHINE_ID, "r") as f:
+ if path_exists(_MACHINE_ID):
+ path = _MACHINE_ID
+ elif path_exists(_DBUS_MACHINE_ID):
+ path = _DBUS_MACHINE_ID
+ else:
+ return None
+
+ with open(path, "r") as f:
try:
machine_id = f.read().strip()
except Exception as e:
@@ -648,6 +741,9 @@ __all__ = [
# boom module constants
'DEFAULT_BOOT_PATH', 'DEFAULT_BOOM_PATH',
+ # Configuration class
+ 'BoomConfig',
+
# Profile format keys
'FMT_VERSION',
'FMT_LVM_ROOT_LV',
@@ -671,6 +767,10 @@ __all__ = [
'set_boot_path',
'set_boom_path',
+ # Persistent configuration
+ 'set_boom_config',
+ 'get_boom_config',
+
# boom exception base class
'BoomError',
diff --git a/boom/bootloader.py b/boom/bootloader.py
index 228c52b..f3669d9 100644
--- a/boom/bootloader.py
+++ b/boom/bootloader.py
@@ -42,7 +42,7 @@ from boom.osprofile import *
from os.path import basename, exists as path_exists, join as path_join
from tempfile import mkstemp
-from os import listdir, rename, fdopen, chmod, unlink, fdatasync, stat
+from os import listdir, rename, fdopen, chmod, unlink, fdatasync, stat, dup
from stat import S_ISBLK
from hashlib import sha1
import logging
@@ -106,8 +106,20 @@ KEY_MAP = {
BOOT_DEVICETREE: "devicetree"
}
+
+def __make_map_key(key_map):
+ """Compatibility function to generate a reverse dictionary on
+ Python 2.6 which does not support dictionary comprehension
+ notation.
+ """
+ map_key = {}
+ for k, v in key_map.items():
+ map_key[v] = k
+ return map_key
+
+
#: Map BLS entry keys to Boom names
-MAP_KEY = {v: k for k, v in KEY_MAP.items()}
+MAP_KEY = __make_map_key(KEY_MAP)
# Module logging configuration
_log = logging.getLogger(__name__)
@@ -1491,6 +1503,10 @@ class BootEntry(object):
entry_path = self._entry_path
(tmp_fd, tmp_path) = mkstemp(prefix="boom", dir=boom_entries_path())
with fdopen(tmp_fd, "w") as f:
+ # Our original file descriptor will be closed on exit from the
+ # fdopen with statement: save a copy so that we can call fdatasync
+ # once at the end of writing rather than on each loop iteration.
+ tmp_fd = dup(tmp_fd)
if self._osp:
# Insert OsIdentifier comment at top-of-file
f.write("#OsIdentifier: %s\n" % self._osp.os_id)
@@ -1503,8 +1519,8 @@ class BootEntry(object):
key_data = (_transform_key(key), getattr(self, key))
f.write(key_fmt % key_data)
f.flush()
- fdatasync(f.fileno())
try:
+ fdatasync(tmp_fd)
rename(tmp_path, entry_path)
chmod(entry_path, BOOT_ENTRY_MODE)
except Exception as e:
diff --git a/boom/command.py b/boom/command.py
index 017d434..3702244 100644
--- a/boom/command.py
+++ b/boom/command.py
@@ -28,6 +28,8 @@ from boom import *
from boom.osprofile import *
from boom.report import *
from boom.bootloader import *
+from boom.legacy import *
+from boom.config import *
import sys
from os import environ, uname
@@ -263,6 +265,16 @@ def _canonicalize_lv_name(lvname):
raise ValueError("Root logical volume name must be in VG/LV format.")
return lvname
+
+def __write_legacy():
+ """Synchronise boom boot entries with the configured legacy
+ bootloader format.
+ """
+ config = get_boom_config()
+ if config.legacy_enable and config.legacy_sync:
+ write_legacy_loader(selection=Selection(), loader=config.legacy_format)
+
+
#
# Command driven API: BootEntry and OsProfile management and reporting.
#
@@ -324,6 +336,7 @@ def create_entry(title, version, machine_id, root_device, lvm_root_lv=None,
if write:
be.write_entry()
+ __write_legacy()
return be
@@ -357,6 +370,8 @@ def delete_entries(selection=None):
be.delete_entry()
deleted += 1
+ __write_legacy()
+
return deleted
@@ -428,6 +443,7 @@ def clone_entry(selection=None, title=None, version=None, machine_id=None,
if write:
clone_be.write_entry()
+ __write_legacy()
return clone_be
@@ -488,8 +504,11 @@ def edit_entry(selection=None, title=None, version=None, machine_id=None,
be.bp.lvm_root_lv = lvm_root_lv or be.bp.lvm_root_lv
be.bp.btrfs_subvol_path = btrfs_subvol_path or be.bp.btrfs_subvol_path
be.bp.btrfs_subvol_id = btrfs_subvol_id or be.bp.btrfs_subvol_id
+
if write:
be.write_entry()
+ __write_legacy()
+
return be
@@ -592,6 +611,7 @@ def _os_profile_from_file(os_release, uname_pattern,
osp.write_profile()
return osp
+
def create_profile(name, short_name, version, version_id,
uname_pattern=None, kernel_pattern=None,
initramfs_pattern=None, root_opts_lvm2=None,
@@ -906,6 +926,20 @@ def print_profiles(selection=None, opts=None, output_fields=None,
return br.report_output()
+
+def show_legacy(selection=None, loader=BOOM_LOADER_GRUB1):
+ """Print boot entries in legacy boot loader formats.
+
+ :param selection: A Selection object giving selection criteria
+ for the operation
+ :param fmt: The name of a legacy boot loader format
+ """
+ (name, decorator, path) = find_legacy_loader(loader, None)
+ bes = find_entries(selection=selection)
+ for be in bes:
+ gbe = Grub1BootEntry(entry_data=be._entry_data)
+ print(gbe)
+
#
# boom command line tool
#
@@ -913,9 +947,12 @@ def print_profiles(selection=None, opts=None, output_fields=None,
def _apply_profile_overrides(boot_entry, cmd_args):
if cmd_args.linux:
boot_entry.linux = cmd_args.linux
+ modified = True
if cmd_args.initrd:
boot_entry.initrd = cmd_args.initrd
+ modified = True
+
def _create_cmd(cmd_args, select, opts, identifier):
"""Create entry command handler.
@@ -954,6 +991,7 @@ def _create_cmd(cmd_args, select, opts, identifier):
# Use host machine-id by default
machine_id = _get_machine_id()
if not machine_id:
+ print("Could not determine machine_id")
return 1
else:
machine_id = cmd_args.machine_id
@@ -1011,7 +1049,11 @@ def _create_cmd(cmd_args, select, opts, identifier):
try:
be.write_entry()
+ __write_legacy()
except Exception as e:
+ if cmd_args.debug:
+ raise
+ print(e)
return 1
print("Created entry with boot_id %s:" % be.disp_boot_id)
@@ -1051,6 +1093,7 @@ def _delete_cmd(cmd_args, select, opts, identifier):
except (ValueError, IndexError) as e:
print(e)
return 1
+
print("Deleted %d entr%s" % (nr, "ies" if nr > 1 else "y"))
@@ -1107,7 +1150,11 @@ def _clone_cmd(cmd_args, select, opts, identifier):
try:
be.write_entry()
- except:
+ __write_legacy()
+ except Exception as e:
+ if cmd_args.debug:
+ raise
+ print(e)
return 1
print("Cloned entry with boot_id %s as boot_id %s:" %
@@ -1209,7 +1256,11 @@ def _edit_cmd(cmd_args, select, opts, identifier):
try:
be.write_entry()
- except:
+ __write_legacy()
+ except Exception as e:
+ if cmd_args.debug:
+ raise
+ print(e)
return 1
print("Edited entry, boot_id now: %s" % be.disp_boot_id)
@@ -1474,7 +1525,40 @@ def _edit_profile_cmd(cmd_args, select, opts, identifier):
return 0
-pass
+def _write_legacy_cmd(cmd_args, select, opts, identifier):
+ if identifier:
+ print("write legacy does not accept a boot_id")
+ return 1
+ config = get_boom_config()
+ try:
+ clear_legacy_loader()
+ write_legacy_loader(selection=select, loader=config.legacy_format)
+ except Exception as e:
+ print(e)
+ return 1
+
+
+def _clear_legacy_cmd(cmd_args, select, opts, identifier):
+ """Remove all boom entries from the legacy bootloader configuration.
+
+ :param cmd_args: Command line arguments for the command
+ :returns: integer status code returned from ``main()``
+ """
+ if identifier:
+ print("write legacy does not accept a boot_id")
+ return 1
+
+ try:
+ clear_legacy_loader()
+ except BoomLegacyFormatError as e:
+ print(e)
+ return 1
+
+
+def _show_legacy_cmd(cmd_args, select, opts, identifier):
+ # FIXME: args
+ config = get_boom_config()
+ show_legacy(selection=select, loader=config.legacy_format)
boom_usage = """%(prog}s [type] <command> [options]\n\n"
@@ -1487,17 +1571,23 @@ boom_usage = """%(prog}s [type] <command> [options]\n\n"
profile delete [...]
profile list [...]
profile edit [...]
+ legacy write [...]
+ legacy delete [...]
"""
CREATE_CMD = "create"
DELETE_CMD = "delete"
CLONE_CMD = "clone"
+CLEAR_CMD = "clear"
SHOW_CMD = "show"
LIST_CMD = "list"
EDIT_CMD = "edit"
+WRITE_CMD = "write"
+
ENTRY_TYPE = "entry"
PROFILE_TYPE = "profile"
+LEGACY_TYPE = "legacy"
_boom_entry_commands = [
(CREATE_CMD, _create_cmd),
@@ -1517,9 +1607,16 @@ _boom_profile_commands = [
(EDIT_CMD, _edit_profile_cmd)
]
+_boom_legacy_commands = [
+ (WRITE_CMD, _write_legacy_cmd),
+ (CLEAR_CMD, _clear_legacy_cmd),
+ (SHOW_CMD, _show_legacy_cmd)
+]
+
_boom_command_types = [
(ENTRY_TYPE, _boom_entry_commands),
- (PROFILE_TYPE, _boom_profile_commands)
+ (PROFILE_TYPE, _boom_profile_commands),
+ (LEGACY_TYPE, _boom_legacy_commands)
]
@@ -1645,6 +1742,8 @@ def main(args):
help="The path or ID of a BTRFS subvolume")
parser.add_argument("--btrfs-opts", "--btrfsopts", metavar="OPTS", type=str,
help="A template option string for BTRFS devices")
+ parser.add_argument("-c", "--config", metavar="FILE", type=str,
+ help="Path to a boom configuration file", default=None)
parser.add_argument("--debug", metavar="DEBUGOPTS", type=str,
help="A list of debug options to enable")
parser.add_argument("-e", "--efi", metavar="IMG", type=str,
@@ -1715,13 +1814,23 @@ def main(args):
"boot entry")
cmd_args = parser.parse_args()
- set_debug(cmd_args.debug)
+ try:
+ set_debug(cmd_args.debug)
+ except ValueError as e:
+ print(e)
+ return 1
setup_logging(cmd_args)
cmd_type = _match_cmd_type(cmd_args.type)
if cmd_args.boot_dir or BOOM_BOOT_PATH_ENV in environ:
boot_path = cmd_args.boot_dir or environ[BOOM_BOOT_PATH_ENV]
set_boot_path(boot_path)
+ set_boom_config_path("boom.conf")
+
+ if cmd_args.config:
+ set_boom_config_path(cmd_args.config)
+
+ load_boom_config(path=cmd_args.config)
# Parse an LV name from root_lv and re-write the root_device if found
if cmd_args.root_lv:
diff --git a/boom/config.py b/boom/config.py
new file mode 100644
index 0000000..d0208be
--- /dev/null
+++ b/boom/config.py
@@ -0,0 +1,242 @@
+# Copyright (C) 2017 Red Hat, Inc., Bryn M. Reeves <bmr@redhat.com>
+#
+# config.py - Boom persistent configuration
+#
+# This file is part of the boom project.
+#
+# This copyrighted material is made available to anyone wishing to use,
+# modify, copy, or redistribute it subject to the terms and conditions
+# of the GNU General Public License v.2.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+"""The ``boom.config`` module defines classes and constants and functions
+for reading and writing persistent (on-disk) configuration for the boom
+library and tools.
+
+Users of the module can load and write configuration data, and obtain
+the values of configuration keys defined in the boom configuration file.
+"""
+from boom import *
+
+from os.path import (
+ isabs, isdir, dirname, exists as path_exists, join as path_join
+)
+
+from os import fdopen, rename, chmod, fdatasync, dup
+from tempfile import mkstemp
+from errno import ENOENT
+import logging
+
+try:
+ # Python2
+ from ConfigParser import SafeConfigParser as ConfigParser, ParsingError
+except:
+ # Python3
+ from configparser import ConfigParser, ParsingError
+
+class BoomConfigError(BoomError):
+ """Base class for boom configuration errors.
+ """
+ pass
+
+# Module logging configuration
+_log = logging.getLogger(__name__)
+
+_log_debug = _log.debug
+_log_info = _log.info
+_log_warn = _log.warning
+_log_error = _log.error
+
+#: Configuration file mode
+BOOT_CONFIG_MODE = 0o644
+
+#: The default configuration file location
+BOOM_CONFIG_FILE = "boom.conf"
+DEFAULT_BOOM_CONFIG_PATH = path_join(get_boom_path(), BOOM_CONFIG_FILE)
+__boom_config_path = DEFAULT_BOOM_CONFIG_PATH
+
+def get_boom_config_path():
+ """Return the currently configured boom configuration file path.
+
+ :returntype: str
+ :returns: the current boom configuration file path
+ """
+ return __boom_config_path
+
+
+def set_boom_config_path(path):
+ """Set the boom configuration file path.
+ """
+ global __boom_config_path
+ path = path or get_boom_config_path()
+ if not isabs(path):
+ path = path_join(get_boom_path())
+ if isdir(path):
+ path = path_join(path, BOOM_CONFIG_FILE)
+ if not path_exists(path):
+ raise IOError(ENOENT, "File not found: '%s'" % path)
+ __boom_config_path = path
+ _log_debug("set boom_config_path to '%s'" % path)
+
+
+#
+# Constants for configuration sections and options: to add a new option,
+# create a new _CFG_* constant giving the name of the option and add a
+# hook to load_boom_config() to set the value when read.
+#
+# To add a new section add the section name constant as _CFG_SECT_* and
+# add a new branch to load_boom_config() to test for the presence of
+# the section and handle the options found within.
+#
+_CFG_SECT_GLOBAL = "global"
+_CFG_SECT_LEGACY = "legacy"
+_CFG_BOOT_ROOT = "boot_root"
+_CFG_BOOM_ROOT = "boom_root"
+_CFG_LEGACY_ENABLE = "enable"
+_CFG_LEGACY_FMT = "format"
+_CFG_LEGACY_SYNC = "sync"
+
+
+def read_boom_config(path=None):
+ """Read boom persistent configuration values from the defined path
+ and return them as a ``BoomConfig`` object.
+
+ :param path: the configuration file to read, or None to read the
+ currently configured config file path.
+
+ :returntype: BoomConfig
+ """
+ path = path or get_boom_config_path()
+ _log_debug("reading boom configuration from '%s'" % path)
+ cfg = ConfigParser()
+ try:
+ cfg.read(path)
+ except ParsingError as e:
+ _log_error("Failed to parse configuration file '%s': %s" %
+ (path, e))
+
+ bc = BoomConfig()
+
+ trues = ['True', 'true', 'Yes', 'yes']
+
+ if cfg.has_section(_CFG_SECT_GLOBAL):
+ if cfg.has_option(_CFG_SECT_GLOBAL, _CFG_BOOT_ROOT):
+ _log_debug("Found global.boot_path")
+ bc.boot_path = cfg.get(_CFG_SECT_GLOBAL, _CFG_BOOT_ROOT)
+ if cfg.has_option(_CFG_SECT_GLOBAL, _CFG_BOOM_ROOT):
+ _log_debug("Found global.boom_path")
+ bc.boom_path = cfg.get(_CFG_SECT_GLOBAL, _CFG_BOOM_ROOT)
+
+ if cfg.has_section(_CFG_SECT_LEGACY):
+ if cfg.has_option(_CFG_SECT_LEGACY, _CFG_LEGACY_ENABLE):
+ _log_debug("Found legacy.enable")
+ enable = cfg.get(_CFG_SECT_LEGACY, _CFG_LEGACY_ENABLE)
+ bc.legacy_enable = any([t for t in trues if t in enable])
+
+ if cfg.has_option(_CFG_SECT_LEGACY, _CFG_LEGACY_FMT):
+ bc.legacy_format = cfg.get(_CFG_SECT_LEGACY,
+ _CFG_LEGACY_FMT)
+
+ if cfg.has_option(_CFG_SECT_LEGACY, _CFG_LEGACY_SYNC):
+ _log_debug("Found legacy.sync")
+ sync = cfg.get(_CFG_SECT_LEGACY, _CFG_LEGACY_SYNC)
+ bc.legacy_sync = any([t for t in trues if t in sync])
+
+ _log_debug("read configuration: %s" % repr(bc))
+ bc._cfg = cfg
+ return bc
+
+
+def load_boom_config(path=None):
+ """Load boom persistent configuration values from the defined path
+ and make the them the active configuration.
+
+ :param path: the configuration file to read, or None to read the
+ currently configured config file path
+
+ :returntype: None
+ """
+ bc = read_boom_config(path=path)
+ set_boom_config(bc)
+
+
+def __sync_config(bc, cfg):
+ """Sync the configuration values of ``BoomConfig`` object ``bc`` to
+ the ``ConfigParser`` ``cfg``.
+ """
+
+ def attr_has_value(obj, attr):
+ return hasattr(obj, attr) and getattr(obj, attr) is not None
+
+ if attr_has_value(bc, "boot_path"):
+ cfg.set(_CFG_SECT_GLOBAL, _CFG_BOOT_ROOT, bc.boot_path)
+ if attr_has_value(bc, "boom_path"):
+ cfg.set(_CFG_SECT_GLOBAL, _CFG_BOOM_ROOT, bc.boom_path)
+ if attr_has_value(bc, "legacy_enable"):
+ cfg.set(_CFG_SECT_LEGACY, _CFG_LEGACY_ENABLE, str(bc.legacy_enable))
+ if attr_has_value(bc, "legacy_format"):
+ cfg.set(_CFG_SECT_LEGACY, _CFG_LEGACY_FMT, bc.legacy_format)
+ if attr_has_value(bc, "legacy_sync"):
+ cfg.set(_CFG_SECT_LEGACY, _CFG_LEGACY_SYNC, bc.legacy_sync)
+
+
+def __make_config(bc):
+ """Create a new ``ConfigParser`` corresponding to the ``BoomConfig``
+ object ``bc`` and return the result.
+ """
+ cfg = ConfigParser()
+ cfg.add_section("global")
+ cfg.add_section("legacy")
+ __sync_config(bc, cfg)
+ return bc
+
+
+def write_boom_config(config=None, path=None):
+ """Write boom configuration to disk.
+
+ :param config: the configuration values to write, or None to
+ write the current configuration
+ :param path: the configuration file to read, or None to read the
+ currently configured config file path
+
+ :returntype: None
+ """
+ path = path or get_boom_config_path()
+ cfg_dir = dirname(path)
+ (tmp_fd, tmp_path) = mkstemp(prefix="boom", dir=cfg_dir)
+
+ config = config or get_boom_config()
+
+ if not config._cfg:
+ config._cfg = __make_config(config)
+ else:
+ __sync_config(config, config._cfg)
+
+ with fdopen(tmp_fd, "w") as f_tmp:
+ config._cfg.write(f_tmp)
+ fdatasync(tmp_fd)
+