File: testhelpers.go

package info (click to toggle)
golang-github-appc-cni 1.1.2-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 1,132 kB
  • sloc: sh: 154; makefile: 7
file content (103 lines) | stat: -rw-r--r-- 2,773 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
// Copyright 2016 CNI authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package testhelpers supports testing of CNI components of different versions
//
// For example, to build a plugin against an old version of the CNI library,
// we can pass the plugin's source and the old git commit reference to BuildAt.
// We could then test how the built binary responds when called by the latest
// version of this library.
package testhelpers

import (
	"fmt"
	"io/ioutil"
	"os"
	"os/exec"
	"path/filepath"
	"strings"
)

const packageBaseName = "github.com/containernetworking/cni"

func run(cmd *exec.Cmd) error {
	out, err := cmd.CombinedOutput()
	if err != nil {
		command := strings.Join(cmd.Args, " ")
		return fmt.Errorf("running %q: %s", command, out)
	}
	return nil
}

// unset GOPATH if it's set, so we use modules
func goBuildEnviron() []string {
	out := []string{}
	for _, kvp := range os.Environ() {
		if !strings.HasPrefix(kvp, "GOPATH=") {
			out = append(out, kvp)
		}
	}
	return out
}

func buildGoProgram(modPath, outputFilePath string) error {
	cmd := exec.Command("go", "build", "-o", outputFilePath, ".")
	cmd.Dir = modPath
	cmd.Env = goBuildEnviron()
	return run(cmd)
}

func modInit(path, name string) error {
	cmd := exec.Command("go", "mod", "init", name)
	cmd.Dir = path
	return run(cmd)
}

func addLibcni(path, gitRef string) error {
	cmd := exec.Command("go", "get", "github.com/containernetworking/cni@"+gitRef)
	cmd.Dir = path
	return run(cmd)
}

// BuildAt builds the go programSource using the version of the CNI library
// at gitRef, and saves the resulting binary file at outputFilePath
func BuildAt(programSource []byte, gitRef string, outputFilePath string) error {
	tempDir, err := ioutil.TempDir(os.Getenv("GOTMPDIR"), "cni-test-")
	if err != nil {
		return err
	}
	defer os.RemoveAll(tempDir)

	modName := filepath.Base(tempDir)

	if err := modInit(tempDir, modName); err != nil {
		return err
	}

	// go get
	if err := addLibcni(tempDir, gitRef); err != nil {
		return err
	}

	if err := ioutil.WriteFile(filepath.Join(tempDir, "main.go"), programSource, 0600); err != nil {
		return err
	}

	err = buildGoProgram(tempDir, outputFilePath)
	if err != nil {
		return fmt.Errorf("failed to build: %w", err)
	}

	return nil
}