File: metadata_test.go

package info (click to toggle)
golang-github-crc-org-crc 2.34.0%2Bds1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,548 kB
  • sloc: sh: 398; makefile: 326; javascript: 40
file content (213 lines) | stat: -rw-r--r-- 6,822 bytes parent folder | download
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
package bundle

import (
	"encoding/json"
	"fmt"
	"path/filepath"
	"strings"
	"testing"
	"unicode"

	"github.com/crc-org/crc/v2/pkg/crc/constants"
	"github.com/crc-org/crc/v2/pkg/crc/logging"
	"github.com/crc-org/crc/v2/pkg/crc/preset"

	"github.com/Masterminds/semver/v3"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func jsonForBundle(name string) string {
	return jsonForBundleWithVersion("1.0", name)
}

func jsonForBundleWithVersion(version, name string) string {
	return fmt.Sprintf(`{
  "version": "%s",
  "type": "snc",
  "name": "%s",
  "buildInfo": {
    "buildTime": "2020-10-26T04:48:26+00:00",
    "openshiftInstallerVersion": "./openshift-install v4.6.0\nbuilt from commit ebdbda57fc18d3b73e69f0f2cc499ddfca7e6593\nrelease image registry.svc.ci.openshift.org/origin/release:4.5",
    "sncVersion": "git4.1.14-137-g14e7"
  },
  "clusterInfo": {
    "openshiftVersion": "%s",
    "clusterName": "crc",
    "baseDomain": "testing",
    "appsDomain": "apps-crc.testing",
    "sshPrivateKeyFile": "id_ecdsa_crc",
    "kubeConfig": "kubeconfig"
  },
  "nodes": [
    {
      "kind": [
        "master",
        "worker"
      ],
      "hostname": "crc-h66l2-master-0",
      "diskImage": "crc.qcow2",
      "internalIP": "192.168.126.11"
    }
  ],
  "storage": {
    "diskImages": [
      {
        "name": "crc.qcow2",
        "format": "qcow2",
	"size": "9",
        "sha256sum": "245a0e5acd4f09000a9a5f37d731082ed1cf3fdcad1b5320cbe9b153c9fd82a4"
      }
    ],
    "fileList": [
      {
        "name": "%s",
        "type": "oc-executable",
        "size": "72728632",
        "sha256sum": "983f0883a6dffd601afa663d10161bfd8033fd6d45cf587a9cb22e9a681d6047"
      }
    ]
  },
  "driverInfo": {
    "name": "libvirt"
  }
}`, version, name, openshiftVersion(name), constants.OcExecutableName)
}

func openshiftVersion(name string) string {
	split := strings.Split(name, "_")
	return split[len(split)-1]
}

var parsedReference = CrcBundleInfo{
	Version: "1.0",
	Type:    "snc",
	Name:    "crc_libvirt_4.6.1",
	BuildInfo: BuildInfo{
		BuildTime:                 "2020-10-26T04:48:26+00:00",
		OpenshiftInstallerVersion: "./openshift-install v4.6.0\nbuilt from commit ebdbda57fc18d3b73e69f0f2cc499ddfca7e6593\nrelease image registry.svc.ci.openshift.org/origin/release:4.5",
		SncVersion:                "git4.1.14-137-g14e7",
	},
	ClusterInfo: ClusterInfo{
		OpenShiftVersion:  semver.MustParse("4.6.1"),
		ClusterName:       "crc",
		BaseDomain:        "testing",
		AppsDomain:        "apps-crc.testing",
		SSHPrivateKeyFile: "id_ecdsa_crc",
		KubeConfig:        "kubeconfig",
	}, Nodes: []Node{
		{
			Kind:       []string{"master", "worker"},
			Hostname:   "crc-h66l2-master-0",
			DiskImage:  "crc.qcow2",
			InternalIP: "192.168.126.11",
		},
	},
	Storage: Storage{
		DiskImages: []DiskImage{
			{
				File: File{
					Name:     "crc.qcow2",
					Size:     "9",
					Checksum: "245a0e5acd4f09000a9a5f37d731082ed1cf3fdcad1b5320cbe9b153c9fd82a4",
				},
				Format: "qcow2",
			},
		},
		Files: []FileListItem{
			{
				File: File{
					Name:     constants.OcExecutableName,
					Size:     "72728632",
					Checksum: "983f0883a6dffd601afa663d10161bfd8033fd6d45cf587a9cb22e9a681d6047",
				},
				Type: "oc-executable",
			},
		},
	},
	DriverInfo: DriverInfo{
		Name: "libvirt",
	},
	cachedPath: "",
}

func TestUnmarshalMarshal(t *testing.T) {
	var bundle CrcBundleInfo
	assert.NoError(t, json.Unmarshal([]byte(jsonForBundle("crc_libvirt_4.6.1")), &bundle))
	assert.Equal(t, parsedReference, bundle)
	bin, err := json.Marshal(bundle)
	assert.NoError(t, err)
	assert.JSONEq(t, string(bin), jsonForBundle("crc_libvirt_4.6.1"))
}

// check that the bundle name has the form "crc_libvirt_4.7.8.crcbundle" or "crc_libvirt_4.7.8_123456.crcbundle"
func checkBundleName(t *testing.T, bundleName string) {
	logging.Debugf("Checking bundle '%s", bundleName)
	baseName := GetBundleNameWithoutExtension(constants.GetDefaultBundle(preset.OpenShift))
	require.True(t, strings.HasPrefix(bundleName, baseName), "%s should start with %s", bundleName, baseName)
	bundleName = bundleName[len(baseName):]
	require.True(t, strings.HasSuffix(bundleName, ".crcbundle"), "%s should have a '.crcbundle' extension", bundleName)
	bundleName = bundleName[:len(bundleName)-len(".crcbundle")]
	if bundleName == "" {
		return
	}
	require.GreaterOrEqual(t, len(bundleName), 2)
	require.Equal(t, rune(bundleName[0]), '_')
	for _, char := range bundleName[1:] {
		require.True(t, unicode.IsDigit(char), "%c should be a digit", char)
	}
}

func TestCustomBundleName(t *testing.T) {
	checkBundleName(t, constants.GetDefaultBundle(preset.OpenShift))
	customBundleName := GetCustomBundleName(constants.GetDefaultBundle(preset.OpenShift))
	checkBundleName(t, customBundleName)
	customBundleName = GetCustomBundleName(customBundleName)
	checkBundleName(t, customBundleName)
}

func TestGetBundleType(t *testing.T) {
	var bundle CrcBundleInfo
	bundle.Type = "okd"
	require.Equal(t, preset.OKD, bundle.GetBundleType())
	bundle.Type = "okd_custom"
	require.Equal(t, preset.OKD, bundle.GetBundleType())
	bundle.Type = "microshift"
	require.Equal(t, preset.Microshift, bundle.GetBundleType())
	bundle.Type = "microshift_custom"
	require.Equal(t, preset.Microshift, bundle.GetBundleType())
	bundle.Type = "openshift"
	require.Equal(t, preset.OpenShift, bundle.GetBundleType())
	bundle.Type = "openshift_custom"
	require.Equal(t, preset.OpenShift, bundle.GetBundleType())
	bundle.Type = "snc"
	require.Equal(t, preset.OpenShift, bundle.GetBundleType())
	bundle.Type = "snc_custom"
	require.Equal(t, preset.OpenShift, bundle.GetBundleType())
	bundle.Type = ""
	require.Equal(t, preset.OpenShift, bundle.GetBundleType())
}

func TestVerifiedHash(t *testing.T) {
	sha256sum, err := getVerifiedHash(testDataURI(t, "sha256sum_correct_4.13.0.txt.sig"), "crc_libvirt_4.13.0_amd64.crcbundle")
	require.NoError(t, err)
	require.Equal(t, "6aad57019aaab95b670378f569b3f4a16398da0358dd1057996453a8d6d92212", sha256sum)

	// sha256sum.txt is unsigned
	_, err = getVerifiedHash(testDataURI(t, "sha256sum.txt"), "crc_libvirt_4.13.0_amd64.crcbundle")
	require.Error(t, err)

	// sha256sum.txt.sig does not contain a sha256sum for fake.crcbundle
	_, err = getVerifiedHash(testDataURI(t, "sha256sum_correct_4.13.0.txt.sig"), "fake.crcbundle")
	require.Error(t, err)

	// the sha256sum file is signed with a GPG key which is not Red Hat's
	_, err = getVerifiedHash(testDataURI(t, "sha256sum_incorrect_4.13.0.txt.sig"), "crc_libvirt_4.13.0_amd64.crcbundle")
	require.ErrorContains(t, err, "signature made by unknown entity")
}

func testDataURI(t *testing.T, sha256sum string) string {
	absPath, err := filepath.Abs(filepath.Join("testdata", sha256sum))
	require.NoError(t, err)
	return fmt.Sprintf("file://%s", filepath.ToSlash(absPath))
}