-
Notifications
You must be signed in to change notification settings - Fork 21
/
artifactory_test.go
251 lines (229 loc) · 9.55 KB
/
artifactory_test.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
239
240
241
242
243
244
245
246
247
248
249
250
251
package main
import (
"errors"
"os"
"os/exec"
"path/filepath"
"testing"
"github.com/stretchr/testify/require"
"github.com/jfrog/jfrog-cli-core/v2/utils/dependencies"
"github.com/jfrog/jfrog-client-go/utils/io/fileutils"
"github.com/stretchr/testify/assert"
biutils "github.com/jfrog/build-info-go/utils"
"github.com/jfrog/jfrog-cli-security/jas"
securityTests "github.com/jfrog/jfrog-cli-security/tests"
securityTestUtils "github.com/jfrog/jfrog-cli-security/tests/utils"
"github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/generic"
commonCommands "github.com/jfrog/jfrog-cli-core/v2/common/commands"
"github.com/jfrog/jfrog-cli-core/v2/common/project"
"github.com/jfrog/jfrog-cli-core/v2/common/spec"
"github.com/jfrog/jfrog-cli-core/v2/utils/config"
"github.com/jfrog/jfrog-cli-core/v2/utils/coreutils"
coreTests "github.com/jfrog/jfrog-cli-core/v2/utils/tests"
clientTests "github.com/jfrog/jfrog-client-go/utils/tests"
)
// We perform validation on dependency resolution from an Artifactory server during the construction of the dependency tree during 'audit' flow.
// This process involves resolving all dependencies required by the project.
func TestDependencyResolutionFromArtifactory(t *testing.T) {
testCases := []struct {
testProjectPath []string
resolveRepoName string
cacheRepoName string
projectType project.ProjectType
}{
{
testProjectPath: []string{"npm", "npm-no-lock"},
resolveRepoName: securityTests.NpmRemoteRepo,
cacheRepoName: securityTests.NpmRemoteRepo,
projectType: project.Npm,
},
{
testProjectPath: []string{"dotnet", "dotnet-single"},
resolveRepoName: securityTests.NugetRemoteRepo,
cacheRepoName: securityTests.NugetRemoteRepo,
projectType: project.Dotnet,
},
{
testProjectPath: []string{"yarn", "yarn-v2"},
resolveRepoName: securityTests.YarnRemoteRepo,
cacheRepoName: securityTests.YarnRemoteRepo,
projectType: project.Yarn,
},
{
testProjectPath: []string{"gradle", "gradleproject"},
resolveRepoName: securityTests.GradleRemoteRepo,
cacheRepoName: securityTests.GradleRemoteRepo,
projectType: project.Gradle,
},
{
testProjectPath: []string{"maven", "mavenproject"},
resolveRepoName: securityTests.MvnRemoteRepo,
cacheRepoName: securityTests.MvnRemoteRepo,
projectType: project.Maven,
},
{
testProjectPath: []string{"maven", "maven-snapshot"},
resolveRepoName: securityTests.MvnVirtualRepo,
cacheRepoName: securityTests.MvnRemoteRepo,
projectType: project.Maven,
},
{
testProjectPath: []string{"go", "simple-project"},
resolveRepoName: securityTests.GoVirtualRepo,
cacheRepoName: securityTests.GoRemoteRepo,
projectType: project.Go,
},
{
testProjectPath: []string{"python", "pipenv", "pipenv", "pipenvproject"},
resolveRepoName: securityTests.PypiRemoteRepo,
cacheRepoName: securityTests.PypiRemoteRepo,
projectType: project.Pipenv,
},
{
testProjectPath: []string{"python", "pip", "pip", "setuppyproject"},
resolveRepoName: securityTests.PypiRemoteRepo,
cacheRepoName: securityTests.PypiRemoteRepo,
projectType: project.Pip,
},
{
testProjectPath: []string{"python", "poetry", "poetry"},
resolveRepoName: securityTests.PypiRemoteRepo,
cacheRepoName: securityTests.PypiRemoteRepo,
projectType: project.Poetry,
},
}
securityTestUtils.CreateJfrogHomeConfig(t, true)
defer securityTestUtils.CleanTestsHomeEnv()
for _, testCase := range testCases {
t.Run(testCase.projectType.String(), func(t *testing.T) {
testSingleTechDependencyResolution(t, testCase.testProjectPath, testCase.resolveRepoName, testCase.cacheRepoName, testCase.projectType)
})
}
}
func testSingleTechDependencyResolution(t *testing.T, testProjectPartialPath []string, resolveRepoName string, cacheRepoName string, projectType project.ProjectType) {
tempDirPath, createTempDirCallback := coreTests.CreateTempDirWithCallbackAndAssert(t)
defer createTempDirCallback()
testProjectPath := filepath.Join(append([]string{filepath.FromSlash(securityTestUtils.GetTestResourcesPath()), "projects", "package-managers"}, testProjectPartialPath...)...)
assert.NoError(t, biutils.CopyDir(testProjectPath, tempDirPath, true, nil))
rootDir, err := os.Getwd()
assert.NoError(t, err)
assert.NoError(t, os.Chdir(tempDirPath))
defer func() {
assert.NoError(t, os.Chdir(rootDir))
}()
server := &config.ServerDetails{
Url: *securityTests.JfrogUrl,
ArtifactoryUrl: *securityTests.JfrogUrl + securityTests.ArtifactoryEndpoint,
XrayUrl: *securityTests.JfrogUrl + securityTests.XrayEndpoint,
AccessToken: *securityTests.JfrogAccessToken,
ServerId: securityTests.ServerId,
}
configCmd := commonCommands.NewConfigCommand(commonCommands.AddOrEdit, securityTests.ServerId).SetDetails(server).SetUseBasicAuthOnly(true).SetInteractive(false)
assert.NoError(t, configCmd.Run())
// Create build config
assert.NoError(t, commonCommands.CreateBuildConfigWithOptions(false, projectType,
commonCommands.WithResolverServerId(server.ServerId),
commonCommands.WithResolverRepo(resolveRepoName),
))
artifactoryPathToSearch := cacheRepoName + "-cache/*"
// To ensure a clean state between test cases, we need to verify that the cache remains clear for remote directories shared across multiple test cases.
deleteCmd := generic.NewDeleteCommand()
deleteCmd.SetServerDetails(server).SetRetries(3).SetSpec(spec.NewBuilder().Pattern(artifactoryPathToSearch).Recursive(true).BuildSpec())
assert.NoError(t, deleteCmd.Run())
callbackFunc := clearOrRedirectLocalCacheIfNeeded(t, projectType)
if callbackFunc != nil {
defer func() {
callbackFunc()
}()
}
// Executing the 'audit' command on an uninstalled project, we anticipate the resolution of dependencies from the configured Artifactory server and repository.
assert.NoError(t, securityTests.PlatformCli.WithoutCredentials().Exec("audit"))
// Following resolution from Artifactory, we anticipate the repository's cache to contain data.
output := coreTests.RunCmdWithOutput(t, func() error {
searchCmd := generic.NewSearchCommand()
searchCmd.SetServerDetails(server).SetRetries(3).SetSpec(spec.NewBuilder().Pattern(artifactoryPathToSearch).Recursive(true).BuildSpec())
err := searchCmd.Run()
if err != nil {
return err
}
// After the resolution from Artifactory, we verify whether the repository's cache is filled with artifacts.
result := searchCmd.Result()
require.NotNil(t, result)
reader := result.Reader()
require.NotNil(t, reader)
defer func() {
err = errors.Join(err, reader.Close())
}()
readerLen, e := reader.Length()
if err = errors.Join(err, e); err != nil {
return err
}
assert.NotEqual(t, 0, readerLen)
return err
})
assert.NotEqual(t, "[]\n", output)
}
// To guarantee that dependencies are resolved from Artifactory, certain package managers may need their local cache to be cleared.
func clearOrRedirectLocalCacheIfNeeded(t *testing.T, projectType project.ProjectType) (callbackFunc func()) {
switch projectType {
case project.Dotnet:
_, err := exec.Command("dotnet", "nuget", "locals", "all", "--clear").CombinedOutput()
assert.NoError(t, err)
case project.Maven:
mavenCacheTempPath, createTempDirCallback := coreTests.CreateTempDirWithCallbackAndAssert(t)
envVarCallbackFunc := clientTests.SetEnvWithCallbackAndAssert(t, securityTests.JvmLaunchEnvVar, securityTests.MavenCacheRedirectionVal+mavenCacheTempPath)
callbackFunc = func() {
envVarCallbackFunc()
createTempDirCallback()
}
case project.Go:
goTempCachePath, createTempDirCallback := coreTests.CreateTempDirWithCallbackAndAssert(t)
envVarCallbackFunc := clientTests.SetEnvWithCallbackAndAssert(t, securityTests.GoCacheEnvVar, goTempCachePath)
callbackFunc = func() {
envVarCallbackFunc()
// To remove the temporary cache in Go and all its contents, appropriate deletion permissions are required.
assert.NoError(t, coreutils.SetPermissionsRecursively(goTempCachePath, 0755))
createTempDirCallback()
}
case project.Pip:
pipTempCachePath, createTempDirCallback := coreTests.CreateTempDirWithCallbackAndAssert(t)
envVarCallbackFunc := clientTests.SetEnvWithCallbackAndAssert(t, securityTests.PipCacheEnvVar, pipTempCachePath)
callbackFunc = func() {
envVarCallbackFunc()
createTempDirCallback()
}
}
return
}
func TestDownloadAnalyzerManagerIfNeeded(t *testing.T) {
// Configure a new JFrog CLI home dir.
tempDirPath, createTempDirCallback := coreTests.CreateTempDirWithCallbackAndAssert(t)
defer createTempDirCallback()
setEnvCallBack := clientTests.SetEnvWithCallbackAndAssert(t, coreutils.HomeDir, tempDirPath)
defer setEnvCallBack()
// Download
err := jas.DownloadAnalyzerManagerIfNeeded(0)
assert.NoError(t, err)
// Validate Analyzer manager app & checksum.sh2 file exist
path, err := jas.GetAnalyzerManagerDirAbsolutePath()
assert.NoError(t, err)
amPath := filepath.Join(path, jas.GetAnalyzerManagerExecutableName())
exists, err := fileutils.IsFileExists(amPath, false)
assert.NoError(t, err)
assert.True(t, exists)
checksumPath := filepath.Join(path, dependencies.ChecksumFileName)
exists, err = fileutils.IsFileExists(checksumPath, false)
assert.NoError(t, err)
assert.True(t, exists)
checksumFileStat, err := os.Stat(checksumPath)
assert.NoError(t, err)
assert.True(t, checksumFileStat.Size() > 0)
// Validate no second download occurred
firstFileStat, err := os.Stat(amPath)
assert.NoError(t, err)
err = jas.DownloadAnalyzerManagerIfNeeded(0)
assert.NoError(t, err)
secondFileStat, err := os.Stat(amPath)
assert.NoError(t, err)
assert.Equal(t, firstFileStat.ModTime(), secondFileStat.ModTime())
}