/
paths.go
238 lines (201 loc) 路 7.77 KB
/
paths.go
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
// Copyright 2016-2018, Pulumi Corporation.
//
// 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 workspace
import (
"fmt"
"os"
"os/user"
"path/filepath"
"strings"
"github.com/pkg/errors"
"github.com/pulumi/pulumi/sdk/go/common/encoding"
"github.com/pulumi/pulumi/sdk/go/common/tokens"
"github.com/pulumi/pulumi/sdk/go/common/util/fsutil"
)
const (
// BackupDir is the name of the folder where backup stack information is stored.
BackupDir = "backups"
// BookkeepingDir is the name of our bookkeeping folder, we store state here (like .git for git).
BookkeepingDir = ".pulumi"
// ConfigDir is the name of the folder that holds local configuration information.
ConfigDir = "config"
// GitDir is the name of the folder git uses to store information.
GitDir = ".git"
// HistoryDir is the name of the directory that holds historical information for projects.
HistoryDir = "history"
// PluginDir is the name of the directory containing plugins.
PluginDir = "plugins"
// PolicyDir is the name of the directory that holds policy packs.
PolicyDir = "policies"
// StackDir is the name of the directory that holds stack information for projects.
StackDir = "stacks"
// TemplateDir is the name of the directory containing templates.
TemplateDir = "templates"
// TemplatePolicyDir is the name of the directory containing templates for Policy Packs.
TemplatePolicyDir = "templates-policy"
// WorkspaceDir is the name of the directory that holds workspace information for projects.
WorkspaceDir = "workspaces"
// IgnoreFile is the name of the file that we use to control what to upload to the service.
IgnoreFile = ".pulumiignore"
// ProjectFile is the base name of a project file.
ProjectFile = "Pulumi"
// RepoFile is the name of the file that holds information specific to the entire repository.
RepoFile = "settings.json"
// WorkspaceFile is the name of the file that holds workspace information.
WorkspaceFile = "workspace.json"
// CachedVersionFile is the name of the file we use to store when we last checked if the CLI was out of date
CachedVersionFile = ".cachedVersionInfo"
// PulumiHomeEnvVar is a path to the '.pulumi' folder with plugins, access token, etc.
// The folder can have any name, not necessarily '.pulumi'.
// It defaults to the '<user's home>/.pulumi' if not specified.
PulumiHomeEnvVar = "PULUMI_HOME"
// PolicyPackFile is the base name of a Pulumi policy pack file.
PolicyPackFile = "PulumiPolicy"
)
// DetectProjectPath locates the closest project from the current working directory, or an error if not found.
func DetectProjectPath() (string, error) {
dir, err := os.Getwd()
if err != nil {
return "", err
}
path, err := DetectProjectPathFrom(dir)
if err != nil {
return "", err
}
return path, nil
}
// DetectProjectStackPath returns the name of the file to store stack specific project settings in. We place stack
// specific settings next to the Pulumi.yaml file, named like: Pulumi.<stack-name>.yaml
func DetectProjectStackPath(stackName tokens.QName) (string, error) {
proj, projPath, err := DetectProjectAndPath()
if err != nil {
return "", err
}
return filepath.Join(filepath.Dir(projPath), proj.Config, fmt.Sprintf("%s.%s%s", ProjectFile, qnameFileName(stackName),
filepath.Ext(projPath))), nil
}
// DetectProjectPathFrom locates the closest project from the given path, searching "upwards" in the directory
// hierarchy. If no project is found, an empty path is returned.
func DetectProjectPathFrom(path string) (string, error) {
return fsutil.WalkUp(path, isProject, func(s string) bool {
return true
})
}
// DetectPolicyPackPathFrom locates the closest Pulumi policy project from the given path,
// searching "upwards" in the directory hierarchy. If no project is found, an empty path is
// returned.
func DetectPolicyPackPathFrom(path string) (string, error) {
return fsutil.WalkUp(path, isPolicyPack, func(s string) bool {
return true
})
}
// DetectProject loads the closest project from the current working directory, or an error if not found.
func DetectProject() (*Project, error) {
proj, _, err := DetectProjectAndPath()
return proj, err
}
func DetectProjectStack(stackName tokens.QName) (*ProjectStack, error) {
path, err := DetectProjectStackPath(stackName)
if err != nil {
return nil, err
}
return LoadProjectStack(path)
}
// DetectProjectAndPath loads the closest package from the current working directory, or an error if not found. It
// also returns the path where the package was found.
func DetectProjectAndPath() (*Project, string, error) {
path, err := DetectProjectPath()
if err != nil {
return nil, "", err
} else if path == "" {
return nil, "", errors.Errorf("no Pulumi project found in the current working directory")
}
proj, err := LoadProject(path)
return proj, path, err
}
// SaveProject saves the project file on top of the existing one, using the standard location.
func SaveProject(proj *Project) error {
path, err := DetectProjectPath()
if err != nil {
return err
}
return proj.Save(path)
}
func SaveProjectStack(stackName tokens.QName, stack *ProjectStack) error {
path, err := DetectProjectStackPath(stackName)
if err != nil {
return err
}
return stack.Save(path)
}
// isProject returns true if the path references what appears to be a valid project. If problems are detected -- like
// an incorrect extension -- they are logged to the provided diag.Sink (if non-nil).
func isProject(path string) bool {
return isMarkupFile(path, ProjectFile)
}
// isPolicyPack returns true if the path references what appears to be a valid policy pack project.
// If problems are detected -- like an incorrect extension -- they are logged to the provided
// diag.Sink (if non-nil).
func isPolicyPack(path string) bool {
return isMarkupFile(path, PolicyPackFile)
}
func isMarkupFile(path string, expect string) bool {
info, err := os.Stat(path)
if err != nil || info.IsDir() {
// Missing files and directories can't be markup files.
return false
}
// Ensure the base name is expected.
name := info.Name()
ext := filepath.Ext(name)
base := strings.TrimSuffix(name, ext)
if base != expect {
return false
}
// Check all supported extensions.
for _, mext := range encoding.Exts {
if name == expect+mext {
return true
}
}
return false
}
// GetCachedVersionFilePath returns the location where the CLI caches information from pulumi.com on the newest
// available version of the CLI
func GetCachedVersionFilePath() (string, error) {
return GetPulumiPath(CachedVersionFile)
}
// GetPulumiHomeDir returns the path of the '.pulumi' folder where Pulumi puts its artifacts.
func GetPulumiHomeDir() (string, error) {
// Allow the folder we use to be overridden by an environment variable
dir := os.Getenv(PulumiHomeEnvVar)
if dir != "" {
return dir, nil
}
// Otherwise, use the current user's home dir + .pulumi
user, err := user.Current()
if err != nil {
return "", errors.Wrapf(err, "getting current user")
}
return filepath.Join(user.HomeDir, BookkeepingDir), nil
}
// GetPulumiPath returns the path to a file or directory under the '.pulumi' folder. It joins the path of
// the '.pulumi' folder with elements passed as arguments.
func GetPulumiPath(elem ...string) (string, error) {
homeDir, err := GetPulumiHomeDir()
if err != nil {
return "", err
}
return filepath.Join(append([]string{homeDir}, elem...)...), nil
}