forked from jfrog/jfrog-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pip_test.go
220 lines (190 loc) · 7.99 KB
/
pip_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
package main
import (
"errors"
"fmt"
"os"
"path/filepath"
"strconv"
"testing"
piputils "github.com/jfrog/jfrog-cli-core/v2/utils/python"
coretests "github.com/jfrog/jfrog-cli-core/v2/utils/tests"
clientTestUtils "github.com/jfrog/jfrog-client-go/utils/tests"
buildinfo "github.com/jfrog/build-info-go/entities"
"github.com/jfrog/jfrog-cli-core/v2/utils/coreutils"
"github.com/jfrog/jfrog-cli/inttestutils"
"github.com/jfrog/jfrog-cli/utils/tests"
"github.com/jfrog/jfrog-client-go/utils/io/fileutils"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestPipInstallNativeSyntax(t *testing.T) {
testPipInstall(t, false)
}
// Deprecated
func TestPipInstallLegacy(t *testing.T) {
testPipInstall(t, true)
}
func testPipInstall(t *testing.T, isLegacy bool) {
// Init pip.
initPipTest(t)
// Populate cli config with 'default' server.
oldHomeDir, newHomeDir := prepareHomeDir(t)
defer func() {
clientTestUtils.SetEnvAndAssert(t, coreutils.HomeDir, oldHomeDir)
clientTestUtils.RemoveAllAndAssert(t, newHomeDir)
}()
// Create test cases.
allTests := []struct {
name string
project string
outputFolder string
moduleId string
args []string
expectedDependencies int
}{
{"setuppy", "setuppyproject", "setuppy", "jfrog-python-example:1.0", []string{".", "--no-cache-dir", "--force-reinstall", "--build-name=" + tests.PipBuildName}, 3},
{"setuppy-verbose", "setuppyproject", "setuppy-verbose", "jfrog-python-example:1.0", []string{".", "--no-cache-dir", "--force-reinstall", "-v", "--build-name=" + tests.PipBuildName}, 3},
{"setuppy-with-module", "setuppyproject", "setuppy-with-module", "setuppy-with-module", []string{".", "--no-cache-dir", "--force-reinstall", "--build-name=" + tests.PipBuildName, "--module=setuppy-with-module"}, 3},
{"requirements", "requirementsproject", "requirements", tests.PipBuildName, []string{"-r", "requirements.txt", "--no-cache-dir", "--force-reinstall", "--build-name=" + tests.PipBuildName}, 5},
{"requirements-verbose", "requirementsproject", "requirements-verbose", tests.PipBuildName, []string{"-r", "requirements.txt", "--no-cache-dir", "--force-reinstall", "-v", "--build-name=" + tests.PipBuildName}, 5},
{"requirements-use-cache", "requirementsproject", "requirements-verbose", "requirements-verbose-use-cache", []string{"-r", "requirements.txt", "--module=requirements-verbose-use-cache", "--build-name=" + tests.PipBuildName}, 5},
}
// Run test cases.
for buildNumber, test := range allTests {
t.Run(test.name, func(t *testing.T) {
cleanVirtualEnv, err := prepareVirtualEnv(t)
assert.NoError(t, err)
if isLegacy {
test.args = append([]string{"rt", "pip-install"}, test.args...)
} else {
test.args = append([]string{"pip", "install"}, test.args...)
}
testPipCmd(t, createPipProject(t, test.outputFolder, test.project), strconv.Itoa(buildNumber), test.moduleId, test.expectedDependencies, test.args)
// cleanup
cleanVirtualEnv()
inttestutils.DeleteBuild(serverDetails.ArtifactoryUrl, tests.PipBuildName, artHttpDetails)
})
}
tests.CleanFileSystem()
}
func prepareVirtualEnv(t *testing.T) (func(), error) {
// Create temp directory
tmpDir, removeTempDir := coretests.CreateTempDirWithCallbackAndAssert(t)
// Change current working directory to the temp directory
currentDir, err := os.Getwd()
if err != nil {
return removeTempDir, err
}
restoreCwd := clientTestUtils.ChangeDirWithCallback(t, currentDir, tmpDir)
defer restoreCwd()
// Create virtual environment
if err = piputils.RunVirtualEnv(); err != nil {
return func() {
removeTempDir()
}, err
}
// Set cache dir
unSetEnvCallback := clientTestUtils.SetEnvWithCallbackAndAssert(t, "PIP_CACHE_DIR", filepath.Join(tmpDir, "cache"))
// Add virtual-environment path to 'PATH' for executing all pip and python commands inside the virtual-environment.
restorePathEnv, err := setPathEnvForPipInstall(t)
return func() {
removeTempDir()
restorePathEnv()
unSetEnvCallback()
}, err
}
func testPipCmd(t *testing.T, projectPath, buildNumber, module string, expectedDependencies int, args []string) {
wd, err := os.Getwd()
assert.NoError(t, err, "Failed to get current dir")
chdirCallback := clientTestUtils.ChangeDirWithCallback(t, wd, projectPath)
defer chdirCallback()
args = append(args, "--build-number="+buildNumber)
jfrogCli := tests.NewJfrogCli(execMain, "jfrog", "")
err = jfrogCli.Exec(args...)
if err != nil {
assert.Fail(t, "Failed executing pip install command", err.Error())
return
}
inttestutils.ValidateGeneratedBuildInfoModule(t, tests.PipBuildName, buildNumber, "", []string{module}, buildinfo.Python)
assert.NoError(t, artifactoryCli.Exec("bp", tests.PipBuildName, buildNumber))
publishedBuildInfo, found, err := tests.GetBuildInfo(serverDetails, tests.PipBuildName, buildNumber)
if err != nil {
assert.NoError(t, err)
return
}
if !found {
assert.True(t, found, "build info was expected to be found")
return
}
buildInfo := publishedBuildInfo.BuildInfo
require.NotEmpty(t, buildInfo.Modules, "Pip build info was not generated correctly, no modules were created.")
assert.Len(t, buildInfo.Modules[0].Dependencies, expectedDependencies, "Incorrect number of dependencies found in the build-info")
assert.Equal(t, module, buildInfo.Modules[0].Id, "Unexpected module name")
assertPipDependenciesRequestedBy(t, buildInfo.Modules[0], module)
}
func assertPipDependenciesRequestedBy(t *testing.T, module buildinfo.Module, moduleName string) {
for _, dependency := range module.Dependencies {
switch dependency.Id {
case "pyyaml:5.1.2", "nltk:3.4.5", "macholib:1.11":
assert.EqualValues(t, [][]string{{moduleName}}, dependency.RequestedBy)
case "six:1.16.0":
assert.EqualValues(t, [][]string{{"nltk:3.4.5", moduleName}}, dependency.RequestedBy)
case "altgraph:0.17.2":
assert.EqualValues(t, [][]string{{"macholib:1.11", moduleName}}, dependency.RequestedBy)
default:
assert.Fail(t, "Unexpected dependency "+dependency.Id)
}
}
}
func createPipProject(t *testing.T, outFolder, projectName string) string {
projectSrc := filepath.Join(filepath.FromSlash(tests.GetTestResourcesPath()), "pip", projectName)
projectTarget := filepath.Join(tests.Out, outFolder+"-"+projectName)
err := fileutils.CreateDirIfNotExist(projectTarget)
assert.NoError(t, err)
// Copy pip-installation file.
err = fileutils.CopyDir(projectSrc, projectTarget, true, nil)
assert.NoError(t, err)
// Copy pip-config file.
configSrc := filepath.Join(filepath.FromSlash(tests.GetTestResourcesPath()), "pip", "pip.yaml")
configTarget := filepath.Join(projectTarget, ".jfrog", "projects")
_, err = tests.ReplaceTemplateVariables(configSrc, configTarget)
assert.NoError(t, err)
return projectTarget
}
func initPipTest(t *testing.T) {
if !*tests.TestPip {
t.Skip("Skipping Pip test. To run Pip test add the '-test.pip=true' option.")
}
require.True(t, isRepoExist(tests.PypiRemoteRepo), "Pypi test remote repository doesn't exist.")
require.True(t, isRepoExist(tests.PypiVirtualRepo), "Pypi test virtual repository doesn't exist.")
}
func setPathEnvForPipInstall(t *testing.T) (func(), error) {
// Get absolute path to virtual environment
virtualEnvPath, err := filepath.Abs(filepath.Join("venv", venvBinDirByOS()))
if err != nil {
return func() {}, err
}
// Keep original value of 'PATH'.
pathValue, exists := os.LookupEnv("PATH")
if !exists {
return func() {}, errors.New("Couldn't find PATH variable, failing pip tests")
}
// Append the path.
var newPathValue string
if coreutils.IsWindows() {
newPathValue = fmt.Sprintf("%s;%s", virtualEnvPath, pathValue)
} else {
newPathValue = fmt.Sprintf("%s:%s", virtualEnvPath, pathValue)
}
// Return original PATH value.
return func() {
clientTestUtils.SetEnvAndAssert(t, "PATH", pathValue)
}, os.Setenv("PATH", newPathValue)
}
// Get the name of the directory inside venv dir that contains the bin files (different name in different OS's)
func venvBinDirByOS() string {
if coreutils.IsWindows() {
return "Scripts"
}
return "bin"
}