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
|
# Copyright (c) 2018 SUSE Linux GmbH. All rights reserved.
#
# This file is part of kiwi.
#
# kiwi 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 3 of the License, or
# (at your option) any later version.
#
# kiwi 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 kiwi. If not, see <http://www.gnu.org/licenses/>
#
import os
from datetime import datetime
# project
from kiwi.path import Path
from kiwi.utils.command_capabilities import CommandCapabilities
from kiwi.utils.sync import DataSync
class OCIBase:
"""
**Base Class for Open Container Interface operations**
An initiative to formulate industry standards around container
formats and runtime is available at https://www.opencontainers.org
Different tools to implement the specifications had been
created. The purpose of this class and its sub-classes is
to provide a common interface in kiwi to allow using all
tools such that the container support in kiwi covers every
linux distribution no matter what tooling was preferred
"""
def __init__(self):
self.oci_root_dir = None
self.creation_date = datetime.utcnow().strftime(
'%Y-%m-%dT%H:%M:%S+00:00'
)
self.post_init()
def __enter__(self):
return self
def post_init(self):
"""
Post initialization method
Implementation in specialized OCI tool class if required
"""
pass
def import_container_image(self, container_image_ref):
"""
Imports container image reference to a working space
Implementation in specialized tool class
:param string container_image_ref: image reference to import
"""
raise NotImplementedError
def export_container_image(
self, filename, transport, image_ref, additional_refs=None
):
"""
Exports the working container to a container image archive
Implementation in specialized tool class
:param str filename: The resulting filename
:param str transport: The archive format
:param str image_ref: Image reference of the exported image
:param list additional_names: List of additional references
"""
raise NotImplementedError
def init_container(self):
"""
Initialize a new container
Implementation in specialized tool class
"""
raise NotImplementedError
def unpack(self):
"""
Unpack current container root data
Implementation in specialized tool class
"""
raise NotImplementedError
def sync_rootfs(self, root_dir, exclude_list=None):
"""
Synchronizes the image root with the rootfs of the container
Implementation in specialized tool class
:param string root_dir: root directory of the prepare step
:param list exclude_list: list of paths to exclude
"""
raise NotImplementedError
def import_rootfs(self, root_dir, exclude_list=None):
"""
Synchronizes the container rootfs with the root tree of the build
Implementation in specialized tool class
:param string root_dir: root directory used in prepare step
:param list exclude_list: list of paths to exclude
"""
raise NotImplementedError
def repack(self, oci_config):
"""
Pack root data directory into container image
Implementation in specialized tool class
:param list oci_config: meta data list
"""
raise NotImplementedError
def set_config(self, oci_config):
"""
Set list of meta data information such as entry_point,
maintainer, etc... to the container. The validation of
the list content is handled by the underlaying toolkit
Implementation in specialized tool class
:param list oci_config: meta data list
"""
raise NotImplementedError
def post_process(self):
"""
Performs latest steps after the container layers is added and
configured.
Implementation in specialized tool class
"""
raise NotImplementedError
@staticmethod
def _sync_data(origin, destination, exclude_list=None, options=None):
"""
Synchronizes the origin and destination paths to be equivalent
:param string origin: the source path
:param string destination: the destination path
"""
sync = DataSync(origin, destination)
sync.sync_data(
options=options, exclude=exclude_list
)
@staticmethod
def _skopeo_provides_tmpdir_option() -> bool:
"""
Check if skopeo provides the --tmpdir option
Beginning with version >= 0.2 skopeo provides it.
"""
tool = 'skopeo'
expected_version = (0, 2, 0)
if Path.which(filename=tool, access_mode=os.X_OK):
if CommandCapabilities.check_version(
tool, expected_version, raise_on_error=False
):
return True
return False
# pragma: no cover
def __exit__(self, exc_type, exc_value, traceback):
pass
|