aboutsummaryrefslogtreecommitdiffstats
path: root/src/orchestrator/utils/utils.go
blob: b591ccb52a7af90ac1aa4e5435c547d9ceaf1079 (plain)
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
/*
 * Copyright 2020 Intel Corporation, Inc
 *
 * 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 (
	"archive/tar"
	"compress/gzip"
	"strings"

	"io"
	"io/ioutil"
	"os"
	"path"
	"path/filepath"

	pkgerrors "github.com/pkg/errors"
	yaml "gopkg.in/yaml.v3"
	log "github.com/onap/multicloud-k8s/src/orchestrator/pkg/infra/logutils"

)

// ListYamlStruct is applied when the kind is list
type ListYamlStruct struct {
	APIVersion string       `yaml:"apiVersion,omitempty"`
	Kind       string       `yaml:"kind,omitempty"`
	items      []YamlStruct `yaml:"items,omitempty"`
}

// YamlStruct represents normal parameters in a manifest file.
// Over the course of time, Pls add more parameters as and when you require.
type YamlStruct struct {
	APIVersion string `yaml:"apiVersion,omitempty"`
	Kind       string `yaml:"kind,omitempty"`
	Metadata   struct {
		Name      string `yaml:"name,omitempty"`
		Namespace string `yaml:"namespace,omitempty"`
		Labels    struct {
			RouterDeisIoRoutable string `yaml:"router.deis.io/routable,omitempty"`
		} `yaml:"labels"`
		Annotations struct {
			RouterDeisIoDomains string `yaml:"router.deis.io/domains,omitempty"`
		} `yaml:"annotations,omitempty"`
	} `yaml:"metadata,omitempty"`
	Spec struct {
		Type     string `yaml:"type,omitempty"`
		Selector struct {
			App string `yaml:"app,omitempty"`
		} `yaml:"selector,omitempty"`
		Ports []struct {
			Name     string `yaml:"name,omitempty"`
			Port     int    `yaml:"port,omitempty"`
			NodePort int    `yaml:"nodePort,omitempty"`
		} `yaml:"ports"`
	} `yaml:"spec"`
}

func (y YamlStruct) isValid() bool {
	if y.APIVersion == "" {
		log.Info("apiVersion is missing in manifest file", log.Fields{})
		return false
	}
	if y.Kind == "" {
		log.Info("kind is missing in manifest file", log.Fields{})
		return false
	}
	if y.Metadata.Name == "" {
		log.Info("metadata.name is missing in manifest file", log.Fields{})
		return false
	}
	return true
}

// ExtractYamlParameters is a method which takes in the abolute path of a manifest file
// and returns a struct accordingly
func ExtractYamlParameters(f string) (YamlStruct, error) {
	filename, _ := filepath.Abs(f)
	yamlFile, err := ioutil.ReadFile(filename)

	var yamlStruct YamlStruct

	err = yaml.Unmarshal(yamlFile, &yamlStruct)
	if err != nil {
		return YamlStruct{}, pkgerrors.New("Cant unmarshal yaml file ..")
	}

	/* This is a special case handling when the kind is "List".
	When the kind is list and the metadata name is empty.
	We set the metadata name as the file name. For eg:
	if filename is "/tmp/helm-tmpl-240995533/prometheus/templates/serviceaccount.yaml-0".
	We set metadata name as "serviceaccount.yaml-0"
	Usually when the kind is list, the list might contains a list of
	*/
	if yamlStruct.Kind == "List" && yamlStruct.Metadata.Name == "" {
		li := strings.LastIndex(filename, "/")
		fn := string(filename[li+1:])
		yamlStruct.Metadata.Name = fn
		log.Info("Setting the metadata", log.Fields{"MetaDataName":fn})
	}
	if yamlStruct.isValid() {
		log.Info(":: YAML parameters ::", log.Fields{"fileName": f, "yamlStruct":yamlStruct})

		return yamlStruct, nil
	}
	log.Info("YAML file has errors", log.Fields{"fileName": f})
	return YamlStruct{}, pkgerrors.Errorf("Cant extract parameters from yaml file :: %s", filename)

}

//ExtractTarBall provides functionality to extract a tar.gz file
//into a temporary location for later use.
//It returns the path to the new location
func ExtractTarBall(r io.Reader) (string, error) {
	//Check if it is a valid gz
	gzf, err := gzip.NewReader(r)
	if err != nil {
		return "", pkgerrors.Wrap(err, "Invalid gzip format")
	}

	//Check if it is a valid tar file
	//Unfortunately this can only be done by inspecting all the tar contents
	tarR := tar.NewReader(gzf)
	first := true

	outDir, _ := ioutil.TempDir("", "k8s-ext-")

	for true {
		header, err := tarR.Next()

		if err == io.EOF {
			//Check if we have just a gzip file without a tar archive inside
			if first {
				return "", pkgerrors.New("Empty or non-existant Tar file found")
			}
			//End of archive
			break
		}

		if err != nil {
			return "", pkgerrors.Wrap(err, "Error reading tar file")
		}

		target := filepath.Join(outDir, header.Name)

		switch header.Typeflag {
		case tar.TypeDir:
			if _, err := os.Stat(target); err != nil {
				// Using 755 read, write, execute for owner
				// groups and others get read and execute permissions
				// on the folder.
				if err := os.MkdirAll(target, 0755); err != nil {
					return "", pkgerrors.Wrap(err, "Creating directory")
				}
			}
		case tar.TypeReg:
			if target == outDir { // Handle '.' substituted to '' entry
				continue
			}

			err = EnsureDirectory(target)
			if err != nil {
				return "", pkgerrors.Wrap(err, "Creating Directory")
			}

			f, err := os.OpenFile(target, os.O_CREATE|os.O_RDWR, os.FileMode(header.Mode))
			if err != nil {
				return "", pkgerrors.Wrap(err, "Creating file")
			}

			// copy over contents
			if _, err := io.Copy(f, tarR); err != nil {
				return "", pkgerrors.Wrap(err, "Copying file content")
			}

			// close for each file instead of a defer for all
			// at the end of the function
			f.Close()
		}

		first = false
	}

	return outDir, nil
}

//EnsureDirectory makes sure that the directories specified in the path exist
//If not, it will create them, if possible.
func EnsureDirectory(f string) error {
	base := path.Dir(f)
	_, err := os.Stat(base)
	if err != nil && !os.IsNotExist(err) {
		return err
	}
	return os.MkdirAll(base, 0755)
}