File: host.go

package info (click to toggle)
golang-github-notaryproject-notation 1.2.0-4
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,160 kB
  • sloc: sh: 202; makefile: 67
file content (87 lines) | stat: -rw-r--r-- 2,491 bytes parent folder | download | duplicates (2)
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
// Copyright The Notary Project 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 utils

import (
	"path/filepath"

	"github.com/onsi/ginkgo/v2"
)

// VirtualHost is a virtualized host machine isolated by environment variable.
type VirtualHost struct {
	Executor *ExecOpts

	userDir string
	env     map[string]string
}

// NewVirtualHost creates a temporary user-level directory and updates
// the "XDG_CONFIG_HOME" environment variable for Executor of the VirtualHost.
func NewVirtualHost(binPath string, options ...HostOption) (*VirtualHost, error) {
	vhost := &VirtualHost{
		Executor: Binary(binPath),
	}

	// setup a temp user directory
	vhost.userDir = ginkgo.GinkgoT().TempDir()

	// set user dir environment variables
	vhost.UpdateEnv(UserConfigEnv(vhost.userDir))

	// set options
	vhost.SetOption(options...)
	return vhost, nil
}

// AbsolutePath returns the absolute path for the given path
// elements that are relative to the user directory.
func (h *VirtualHost) AbsolutePath(elem ...string) string {
	userElem := []string{h.userDir}
	userElem = append(userElem, elem...)
	return filepath.Join(userElem...)
}

// UpdateEnv updates the environment variables for the VirtualHost.
func (h *VirtualHost) UpdateEnv(env map[string]string) {
	if h.env == nil {
		h.env = make(map[string]string)
	}
	for key, value := range env {
		h.env[key] = value
	}
	// update ExecOpts.env
	h.Executor.WithEnv(h.env)
}

// SetOption sets the options for the host.
func (h *VirtualHost) SetOption(options ...HostOption) {
	for _, option := range options {
		if err := option(h); err != nil {
			panic(err)
		}
	}
}

// HostOption is a function to set the host configuration.
type HostOption func(vhost *VirtualHost) error

// UserConfigEnv creates environment variable for changing
// user config dir (By setting $XDG_CONFIG_HOME).
func UserConfigEnv(dir string) map[string]string {
	// create and set user dir for linux
	return map[string]string{
		"XDG_CONFIG_HOME": dir,
	}
}