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
|
package bundle
import (
"context"
"encoding/json"
"fmt"
"os"
"path/filepath"
"runtime"
"sort"
"time"
"github.com/Masterminds/semver/v3"
"github.com/crc-org/crc/v2/pkg/crc/constants"
crcerrors "github.com/crc-org/crc/v2/pkg/crc/errors"
"github.com/crc-org/crc/v2/pkg/crc/logging"
"github.com/crc-org/crc/v2/pkg/extract"
crcos "github.com/crc-org/crc/v2/pkg/os"
crcstrings "github.com/crc-org/crc/v2/pkg/strings"
"github.com/pkg/errors"
)
const (
supportedVersion = "^1.0"
bundleExtension = ".crcbundle"
metadataFilename = "crc-bundle-info.json"
)
type Repository struct {
CacheDir string
OcBinDir string
PodmanBinDir string
}
func (repo *Repository) Get(bundleName string) (*CrcBundleInfo, error) {
path := filepath.Join(repo.CacheDir, GetBundleNameWithoutExtension(bundleName))
if _, err := os.Stat(path); err != nil {
return nil, errors.Wrapf(err, "could not find cached bundle info in %s", path)
}
jsonFilepath := filepath.Join(path, metadataFilename)
content, err := os.ReadFile(jsonFilepath)
if err != nil {
return nil, errors.Wrapf(err, "error reading %s file", jsonFilepath)
}
var bundleInfo CrcBundleInfo
if err := json.Unmarshal(content, &bundleInfo); err != nil {
return nil, errors.Wrap(err, "error Unmarshal the data")
}
if err := checkVersion(bundleInfo); err != nil {
return nil, err
}
bundleInfo.cachedPath = path
if err := bundleInfo.verify(); err != nil {
return nil, err
}
if !bundleInfo.IsPodman() {
// TODO: update this logic after major release of bundle like 4.14
// As of now we are using this logic to support older bundles of microshift and it need to be updated
// to only provide app domain route information as per preset.
if !crcstrings.Contains([]string{constants.AppsDomain, constants.MicroShiftAppDomain}, fmt.Sprintf(".%s", bundleInfo.ClusterInfo.AppsDomain)) {
return nil, fmt.Errorf("unexpected bundle, it must have %s or %s apps domain", constants.AppsDomain, constants.MicroShiftAppDomain)
}
if bundleInfo.GetAPIHostname() != fmt.Sprintf("api%s", constants.ClusterDomain) {
return nil, fmt.Errorf("unexpected bundle, it must have %s base domain", constants.ClusterDomain)
}
}
return &bundleInfo, nil
}
func checkVersion(bundleInfo CrcBundleInfo) error {
version, err := semver.NewVersion(bundleInfo.Version)
if err != nil {
return errors.Wrap(err, "cannot parse bundle version")
}
constraint, err := semver.NewConstraint(supportedVersion)
if err != nil {
return errors.Wrap(err, "cannot parse version constraint")
}
if !constraint.Check(version) {
return fmt.Errorf("cannot use bundle with version %s, bundle version must satisfy %s constraint", bundleInfo.Version, supportedVersion)
}
return nil
}
func (repo *Repository) Use(bundleName string) (*CrcBundleInfo, error) {
bundleInfo, err := repo.Get(bundleName)
if err != nil {
return nil, err
}
if err := bundleInfo.createSymlinkOrCopyOpenShiftClient(repo.OcBinDir); err != nil {
return nil, err
}
if err := bundleInfo.createSymlinkOrCopyPodmanRemote(repo.PodmanBinDir); err != nil {
return nil, err
}
return bundleInfo, nil
}
func (bundle *CrcBundleInfo) copyExecutableFromBundle(destDir string, fileType FileType, executableName string) error {
srcPath := bundle.getHelperPath(fileType)
if srcPath == "" {
// this can happen if the bundle metadata does not list an executable for 'fileType'
return nil
}
destPath := filepath.Join(destDir, executableName)
if err := os.MkdirAll(destDir, 0750); err != nil {
return err
}
_ = os.Remove(destPath)
if runtime.GOOS == "windows" {
return crcos.CopyFileContents(srcPath, destPath, 0750)
}
// on unix-like OSes, a symlink is good enough, no need for a copy
return os.Symlink(srcPath, destPath)
}
func (bundle *CrcBundleInfo) createSymlinkOrCopyOpenShiftClient(ocBinDir string) error {
return bundle.copyExecutableFromBundle(ocBinDir, OcExecutable, constants.OcExecutableName)
}
func (bundle *CrcBundleInfo) createSymlinkOrCopyPodmanRemote(binDir string) error {
return bundle.copyExecutableFromBundle(binDir, PodmanExecutable, constants.PodmanRemoteExecutableName)
}
func (repo *Repository) Extract(path string) error {
bundleName := filepath.Base(path)
tmpDir := filepath.Join(repo.CacheDir, "tmp-extract")
_ = os.RemoveAll(tmpDir) // clean up before using it
defer func() {
_ = os.RemoveAll(tmpDir) // clean up after using it
}()
if _, err := extract.Uncompress(path, tmpDir); err != nil {
return err
}
bundleBaseDir := GetBundleNameWithoutExtension(bundleName)
bundleDir := filepath.Join(repo.CacheDir, bundleBaseDir)
_ = os.RemoveAll(bundleDir)
err := crcerrors.Retry(context.Background(), time.Minute, func() error {
if err := os.Rename(filepath.Join(tmpDir, bundleBaseDir), bundleDir); err != nil {
return &crcerrors.RetriableError{Err: err}
}
return nil
}, 5*time.Second)
if err != nil {
return err
}
return os.Chmod(bundleDir, 0755)
}
func (repo *Repository) List() ([]CrcBundleInfo, error) {
files, err := os.ReadDir(repo.CacheDir)
if err != nil {
return nil, err
}
var ret []CrcBundleInfo
for _, file := range files {
if !file.IsDir() {
continue
}
bundle, err := repo.Get(file.Name())
if err != nil {
logging.Errorf("cannot load bundle %s: %v", file.Name(), err)
continue
}
ret = append(ret, *bundle)
}
sort.Slice(ret, func(i, j int) bool {
return ret[i].ClusterInfo.OpenShiftVersion.GreaterThan(ret[j].ClusterInfo.OpenShiftVersion)
})
return ret, nil
}
func (repo *Repository) CalculateBundleSha256Sum(bundlePath string) (string, error) {
return sha256sum(bundlePath)
}
var defaultRepo = &Repository{
CacheDir: constants.MachineCacheDir,
OcBinDir: constants.CrcOcBinDir,
PodmanBinDir: constants.CrcPodmanBinDir,
}
func Get(bundleName string) (*CrcBundleInfo, error) {
return defaultRepo.Get(bundleName)
}
func CalculateBundleSha256Sum(bundlePath string) (string, error) {
return defaultRepo.CalculateBundleSha256Sum(bundlePath)
}
func Use(bundleName string) (*CrcBundleInfo, error) {
return defaultRepo.Use(bundleName)
}
func Extract(path string) (*CrcBundleInfo, error) {
if err := defaultRepo.Extract(path); err != nil {
return nil, err
}
return defaultRepo.Get(filepath.Base(path))
}
func List() ([]CrcBundleInfo, error) {
return defaultRepo.List()
}
|
