Skip to content

Commit b20292c

Browse files
teodora-sanduteodora-sandu
committed
refactor: move the deepcode package
1 parent eefe3f0 commit b20292c

File tree

14 files changed

+65
-60
lines changed

14 files changed

+65
-60
lines changed

‎internal/bundle/bundle.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@ package bundle
1818

1919
import (
2020
"context"
21+
2122
"github.com/rs/zerolog"
2223

23-
"github.com/snyk/code-client-go/deepcode"
24+
"github.com/snyk/code-client-go/internal/deepcode"
2425
"github.com/snyk/code-client-go/observability"
2526
)
2627

‎internal/bundle/bundle_manager.go

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,20 @@ package bundle
1818

1919
import (
2020
"context"
21+
deepcode2 "github.com/snyk/code-client-go/internal/deepcode"
2122
"os"
2223
"path/filepath"
2324

2425
"github.com/puzpuzpuz/xsync"
2526
"github.com/rs/zerolog"
2627

27-
"github.com/snyk/code-client-go/deepcode"
2828
"github.com/snyk/code-client-go/internal/util"
2929
"github.com/snyk/code-client-go/observability"
3030
)
3131

3232
// TODO: add progress tracker for percentage progress
3333
type bundleManager struct {
34-
SnykCode deepcode.SnykCodeClient
34+
SnykCode deepcode2.SnykCodeClient
3535
instrumentor observability.Instrumentor
3636
errorReporter observability.ErrorReporter
3737
logger *zerolog.Logger
@@ -52,13 +52,13 @@ type BundleManager interface {
5252
ctx context.Context,
5353
requestId string,
5454
originalBundle Bundle,
55-
files map[string]deepcode.BundleFile,
55+
files map[string]deepcode2.BundleFile,
5656
) (Bundle, error)
5757
}
5858

5959
func NewBundleManager(
6060
logger *zerolog.Logger,
61-
SnykCode deepcode.SnykCodeClient,
61+
SnykCode deepcode2.SnykCodeClient,
6262
instrumentor observability.Instrumentor,
6363
errorReporter observability.ErrorReporter,
6464
) *bundleManager {
@@ -83,7 +83,7 @@ func (b *bundleManager) Create(ctx context.Context,
8383

8484
var limitToFiles []string
8585
fileHashes := make(map[string]string)
86-
bundleFiles := make(map[string]deepcode.BundleFile)
86+
bundleFiles := make(map[string]deepcode2.BundleFile)
8787
noFiles := true
8888
for absoluteFilePath := range filePaths {
8989
noFiles = false
@@ -116,7 +116,7 @@ func (b *bundleManager) Create(ctx context.Context,
116116
}
117117
relativePath = util.EncodePath(relativePath)
118118

119-
bundleFile := deepcode.BundleFileFrom(absoluteFilePath, fileContent)
119+
bundleFile := deepcode2.BundleFileFrom(absoluteFilePath, fileContent)
120120
bundleFiles[relativePath] = bundleFile
121121
fileHashes[relativePath] = bundleFile.Hash
122122

@@ -151,7 +151,7 @@ func (b *bundleManager) Upload(
151151
ctx context.Context,
152152
requestId string,
153153
bundle Bundle,
154-
files map[string]deepcode.BundleFile,
154+
files map[string]deepcode2.BundleFile,
155155
) (Bundle, error) {
156156
method := "code.Batch"
157157
s := b.instrumentor.StartSpan(ctx, method)
@@ -181,14 +181,14 @@ func (b *bundleManager) Upload(
181181
func (b *bundleManager) groupInBatches(
182182
ctx context.Context,
183183
bundle Bundle,
184-
files map[string]deepcode.BundleFile,
184+
files map[string]deepcode2.BundleFile,
185185
) []*Batch {
186186
method := "code.groupInBatches"
187187
s := b.instrumentor.StartSpan(ctx, method)
188188
defer b.instrumentor.Finish(s)
189189

190190
var batches []*Batch
191-
batch := NewBatch(map[string]deepcode.BundleFile{})
191+
batch := NewBatch(map[string]deepcode2.BundleFile{})
192192
for _, filePath := range bundle.GetMissingFiles() {
193193
if len(batches) == 0 { // first batch added after first file found
194194
batches = append(batches, batch)
@@ -201,7 +201,7 @@ func (b *bundleManager) groupInBatches(
201201
batch.documents[filePath] = file
202202
} else {
203203
b.logger.Trace().Str("path", filePath).Int("size", len(fileContent)).Msgf("created new deepCodeBundle - %v bundles in this upload so far", len(batches))
204-
newUploadBatch := NewBatch(map[string]deepcode.BundleFile{})
204+
newUploadBatch := NewBatch(map[string]deepcode2.BundleFile{})
205205
newUploadBatch.documents[filePath] = file
206206
batches = append(batches, newUploadBatch)
207207
batch = newUploadBatch

‎internal/bundle/bundle_manager_test.go

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ package bundle_test
1919
import (
2020
"bytes"
2121
"context"
22-
bundle2 "github.com/snyk/code-client-go/internal/bundle"
2322
"os"
2423
"path/filepath"
2524
"strings"
@@ -30,8 +29,9 @@ import (
3029
"github.com/stretchr/testify/assert"
3130
"github.com/stretchr/testify/require"
3231

33-
deepcode2 "github.com/snyk/code-client-go/deepcode"
34-
mocks2 "github.com/snyk/code-client-go/deepcode/mocks"
32+
"github.com/snyk/code-client-go/internal/bundle"
33+
"github.com/snyk/code-client-go/internal/deepcode"
34+
deepcodeMocks "github.com/snyk/code-client-go/internal/deepcode/mocks"
3535
"github.com/snyk/code-client-go/internal/util"
3636
"github.com/snyk/code-client-go/observability/mocks"
3737
)
@@ -42,8 +42,8 @@ func Test_Create(t *testing.T) {
4242
ctrl := gomock.NewController(t)
4343
mockSpan := mocks.NewMockSpan(ctrl)
4444
mockSpan.EXPECT().Context().AnyTimes()
45-
mockSnykCodeClient := mocks2.NewMockSnykCodeClient(ctrl)
46-
mockSnykCodeClient.EXPECT().GetFilters(gomock.Any()).Return(deepcode2.FiltersResponse{
45+
mockSnykCodeClient := deepcodeMocks.NewMockSnykCodeClient(ctrl)
46+
mockSnykCodeClient.EXPECT().GetFilters(gomock.Any()).Return(deepcode.FiltersResponse{
4747
ConfigFiles: []string{},
4848
Extensions: []string{".java"},
4949
}, nil)
@@ -61,7 +61,7 @@ func Test_Create(t *testing.T) {
6161
err := os.WriteFile(file, []byte(data), 0600)
6262
require.NoError(t, err)
6363

64-
var bundleManager = bundle2.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
64+
var bundleManager = bundle.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
6565
bundle, err := bundleManager.Create(context.Background(),
6666
"testRequestId",
6767
dir,
@@ -77,8 +77,8 @@ func Test_Create(t *testing.T) {
7777
ctrl := gomock.NewController(t)
7878
mockSpan := mocks.NewMockSpan(ctrl)
7979
mockSpan.EXPECT().Context().AnyTimes()
80-
mockSnykCodeClient := mocks2.NewMockSnykCodeClient(ctrl)
81-
mockSnykCodeClient.EXPECT().GetFilters(gomock.Any()).Return(deepcode2.FiltersResponse{
80+
mockSnykCodeClient := deepcodeMocks.NewMockSnykCodeClient(ctrl)
81+
mockSnykCodeClient.EXPECT().GetFilters(gomock.Any()).Return(deepcode.FiltersResponse{
8282
ConfigFiles: []string{},
8383
Extensions: []string{".java"},
8484
}, nil)
@@ -93,7 +93,7 @@ func Test_Create(t *testing.T) {
9393
err := os.WriteFile(file, []byte(data), 0600)
9494
require.NoError(t, err)
9595

96-
var bundleManager = bundle2.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
96+
var bundleManager = bundle.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
9797
bundle, err := bundleManager.Create(context.Background(),
9898
"testRequestId",
9999
dir,
@@ -110,8 +110,8 @@ func Test_Create(t *testing.T) {
110110
ctrl := gomock.NewController(t)
111111
mockSpan := mocks.NewMockSpan(ctrl)
112112
mockSpan.EXPECT().Context().AnyTimes()
113-
mockSnykCodeClient := mocks2.NewMockSnykCodeClient(ctrl)
114-
mockSnykCodeClient.EXPECT().GetFilters(gomock.Any()).Return(deepcode2.FiltersResponse{
113+
mockSnykCodeClient := deepcodeMocks.NewMockSnykCodeClient(ctrl)
114+
mockSnykCodeClient.EXPECT().GetFilters(gomock.Any()).Return(deepcode.FiltersResponse{
115115
ConfigFiles: []string{},
116116
Extensions: []string{".java"},
117117
}, nil)
@@ -130,7 +130,7 @@ func Test_Create(t *testing.T) {
130130
)
131131
require.NoError(t, err)
132132

133-
var bundleManager = bundle2.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
133+
var bundleManager = bundle.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
134134
bundle, err := bundleManager.Create(context.Background(),
135135
"testRequestId",
136136
dir,
@@ -147,8 +147,8 @@ func Test_Create(t *testing.T) {
147147
ctrl := gomock.NewController(t)
148148
mockSpan := mocks.NewMockSpan(ctrl)
149149
mockSpan.EXPECT().Context().AnyTimes()
150-
mockSnykCodeClient := mocks2.NewMockSnykCodeClient(ctrl)
151-
mockSnykCodeClient.EXPECT().GetFilters(gomock.Any()).Return(deepcode2.FiltersResponse{
150+
mockSnykCodeClient := deepcodeMocks.NewMockSnykCodeClient(ctrl)
151+
mockSnykCodeClient.EXPECT().GetFilters(gomock.Any()).Return(deepcode.FiltersResponse{
152152
ConfigFiles: []string{},
153153
Extensions: []string{".java"},
154154
}, nil)
@@ -166,7 +166,7 @@ func Test_Create(t *testing.T) {
166166
},
167167
)
168168
require.NoError(t, err)
169-
var bundleManager = bundle2.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
169+
var bundleManager = bundle.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
170170
bundle, err := bundleManager.Create(context.Background(),
171171
"testRequestId",
172172
dir,
@@ -181,8 +181,8 @@ func Test_Create(t *testing.T) {
181181
ctrl := gomock.NewController(t)
182182
mockSpan := mocks.NewMockSpan(ctrl)
183183
mockSpan.EXPECT().Context().AnyTimes()
184-
mockSnykCodeClient := mocks2.NewMockSnykCodeClient(ctrl)
185-
mockSnykCodeClient.EXPECT().GetFilters(gomock.Any()).Return(deepcode2.FiltersResponse{
184+
mockSnykCodeClient := deepcodeMocks.NewMockSnykCodeClient(ctrl)
185+
mockSnykCodeClient.EXPECT().GetFilters(gomock.Any()).Return(deepcode.FiltersResponse{
186186
ConfigFiles: []string{".test"},
187187
Extensions: []string{},
188188
}, nil)
@@ -199,7 +199,7 @@ func Test_Create(t *testing.T) {
199199
err := os.WriteFile(file, []byte("some content so the file won't be skipped"), 0600)
200200
assert.Nil(t, err)
201201

202-
var bundleManager = bundle2.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
202+
var bundleManager = bundle.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
203203
bundle, err := bundleManager.Create(context.Background(),
204204
"testRequestId",
205205
tempDir,
@@ -214,8 +214,8 @@ func Test_Create(t *testing.T) {
214214
ctrl := gomock.NewController(t)
215215
mockSpan := mocks.NewMockSpan(ctrl)
216216
mockSpan.EXPECT().Context().AnyTimes()
217-
mockSnykCodeClient := mocks2.NewMockSnykCodeClient(ctrl)
218-
mockSnykCodeClient.EXPECT().GetFilters(gomock.Any()).Return(deepcode2.FiltersResponse{
217+
mockSnykCodeClient := deepcodeMocks.NewMockSnykCodeClient(ctrl)
218+
mockSnykCodeClient.EXPECT().GetFilters(gomock.Any()).Return(deepcode.FiltersResponse{
219219
ConfigFiles: []string{},
220220
Extensions: []string{".java"},
221221
}, nil)
@@ -247,7 +247,7 @@ func Test_Create(t *testing.T) {
247247
require.NoError(t, err)
248248
}
249249

250-
var bundleManager = bundle2.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
250+
var bundleManager = bundle.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
251251
bundle, err := bundleManager.Create(context.Background(),
252252
"testRequestId",
253253
tempDir,
@@ -272,22 +272,22 @@ func Test_Upload(t *testing.T) {
272272
ctrl := gomock.NewController(t)
273273
mockSpan := mocks.NewMockSpan(ctrl)
274274
mockSpan.EXPECT().Context().AnyTimes()
275-
mockSnykCodeClient := mocks2.NewMockSnykCodeClient(ctrl)
275+
mockSnykCodeClient := deepcodeMocks.NewMockSnykCodeClient(ctrl)
276276
mockSnykCodeClient.EXPECT().ExtendBundle(gomock.Any(), "bundleHash", gomock.Len(1), []string{}).Times(1)
277277
mockInstrumentor := mocks.NewMockInstrumentor(ctrl)
278278
mockInstrumentor.EXPECT().StartSpan(gomock.Any(), gomock.Any()).Return(mockSpan).Times(2)
279279
mockInstrumentor.EXPECT().Finish(gomock.Any()).Times(2)
280280
mockErrorReporter := mocks.NewMockErrorReporter(ctrl)
281281

282-
var bundleManager = bundle2.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
282+
var bundleManager = bundle.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
283283
documentURI, bundleFile := createTempFileInDir(t, "bundleDoc.java", 10, temporaryDir)
284-
bundleFileMap := map[string]deepcode2.BundleFile{}
284+
bundleFileMap := map[string]deepcode.BundleFile{}
285285
bundleFileMap[documentURI] = bundleFile
286286

287287
_, err := bundleManager.Upload(
288288
context.Background(),
289289
"testRequestId",
290-
bundle2.NewBundle(mockSnykCodeClient, mockInstrumentor, mockErrorReporter, &logger, "bundleHash", bundleFileMap, []string{}, []string{documentURI}),
290+
bundle.NewBundle(mockSnykCodeClient, mockInstrumentor, mockErrorReporter, &logger, "bundleHash", bundleFileMap, []string{}, []string{documentURI}),
291291
bundleFileMap)
292292
assert.NoError(t, err)
293293
})
@@ -296,16 +296,16 @@ func Test_Upload(t *testing.T) {
296296
ctrl := gomock.NewController(t)
297297
mockSpan := mocks.NewMockSpan(ctrl)
298298
mockSpan.EXPECT().Context().AnyTimes()
299-
mockSnykCodeClient := mocks2.NewMockSnykCodeClient(ctrl)
299+
mockSnykCodeClient := deepcodeMocks.NewMockSnykCodeClient(ctrl)
300300
mockSnykCodeClient.EXPECT().ExtendBundle(gomock.Any(), "bundleHash", gomock.Len(3), []string{}).Return("newBundleHash", []string{}, nil).Times(1)
301301
mockSnykCodeClient.EXPECT().ExtendBundle(gomock.Any(), "newBundleHash", gomock.Len(2), []string{}).Return("newerBundleHash", []string{}, nil).Times(1)
302302
mockInstrumentor := mocks.NewMockInstrumentor(ctrl)
303303
mockInstrumentor.EXPECT().StartSpan(gomock.Any(), gomock.Any()).Return(mockSpan).Times(2)
304304
mockInstrumentor.EXPECT().Finish(gomock.Any()).Times(2)
305305
mockErrorReporter := mocks.NewMockErrorReporter(ctrl)
306-
var bundleManager = bundle2.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
306+
var bundleManager = bundle.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
307307

308-
bundleFileMap := map[string]deepcode2.BundleFile{}
308+
bundleFileMap := map[string]deepcode.BundleFile{}
309309
var missingFiles []string
310310
path, bundleFile := createTempFileInDir(t, "bundleDoc1.java", (1024*1024)-1, temporaryDir)
311311
bundleFileMap[path] = bundleFile
@@ -326,29 +326,29 @@ func Test_Upload(t *testing.T) {
326326
_, err := bundleManager.Upload(
327327
context.Background(),
328328
"testRequestId",
329-
bundle2.NewBundle(mockSnykCodeClient, mockInstrumentor, mockErrorReporter, &logger, "bundleHash", bundleFileMap, []string{}, missingFiles),
329+
bundle.NewBundle(mockSnykCodeClient, mockInstrumentor, mockErrorReporter, &logger, "bundleHash", bundleFileMap, []string{}, missingFiles),
330330
bundleFileMap)
331331
assert.Nil(t, err)
332332
})
333333
}
334334

335-
func createTempFileInDir(t *testing.T, name string, size int, temporaryDir string) (string, deepcode2.BundleFile) {
335+
func createTempFileInDir(t *testing.T, name string, size int, temporaryDir string) (string, deepcode.BundleFile) {
336336
t.Helper()
337337

338338
documentURI, fileContent := createFileOfSize(t, name, size, temporaryDir)
339-
return documentURI, deepcode2.BundleFile{Hash: util.Hash(fileContent), Content: string(fileContent)}
339+
return documentURI, deepcode.BundleFile{Hash: util.Hash(fileContent), Content: string(fileContent)}
340340
}
341341

342342
func Test_IsSupported_Extensions(t *testing.T) {
343343
ctrl := gomock.NewController(t)
344-
mockSnykCodeClient := mocks2.NewMockSnykCodeClient(ctrl)
345-
mockSnykCodeClient.EXPECT().GetFilters(gomock.Any()).Return(deepcode2.FiltersResponse{
344+
mockSnykCodeClient := deepcodeMocks.NewMockSnykCodeClient(ctrl)
345+
mockSnykCodeClient.EXPECT().GetFilters(gomock.Any()).Return(deepcode.FiltersResponse{
346346
ConfigFiles: []string{},
347347
Extensions: []string{".java"},
348348
}, nil)
349349
mockInstrumentor := mocks.NewMockInstrumentor(ctrl)
350350
mockErrorReporter := mocks.NewMockErrorReporter(ctrl)
351-
bundler := bundle2.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
351+
bundler := bundle.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
352352

353353
t.Run("should return true for supported languages", func(t *testing.T) {
354354
supported, _ := bundler.IsSupported(context.Background(), "C:\\some\\path\\Test.java")
@@ -380,14 +380,14 @@ func Test_IsSupported_ConfigFiles(t *testing.T) {
380380
}
381381

382382
ctrl := gomock.NewController(t)
383-
mockSnykCodeClient := mocks2.NewMockSnykCodeClient(ctrl)
384-
mockSnykCodeClient.EXPECT().GetFilters(gomock.Any()).Return(deepcode2.FiltersResponse{
383+
mockSnykCodeClient := deepcodeMocks.NewMockSnykCodeClient(ctrl)
384+
mockSnykCodeClient.EXPECT().GetFilters(gomock.Any()).Return(deepcode.FiltersResponse{
385385
ConfigFiles: configFilesFromFiltersEndpoint,
386386
Extensions: []string{},
387387
}, nil)
388388
mockInstrumentor := mocks.NewMockInstrumentor(ctrl)
389389
mockErrorReporter := mocks.NewMockErrorReporter(ctrl)
390-
bundler := bundle2.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
390+
bundler := bundle.NewBundleManager(newLogger(t), mockSnykCodeClient, mockInstrumentor, mockErrorReporter)
391391
dir, _ := os.Getwd()
392392

393393
t.Run("should return true for supported config files", func(t *testing.T) {

‎internal/bundle/bundle_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ import (
2525
"github.com/stretchr/testify/assert"
2626
"github.com/stretchr/testify/require"
2727

28-
"github.com/snyk/code-client-go/deepcode"
29-
deepcodeMocks "github.com/snyk/code-client-go/deepcode/mocks"
3028
"github.com/snyk/code-client-go/internal/bundle"
29+
"github.com/snyk/code-client-go/internal/deepcode"
30+
deepcodeMocks "github.com/snyk/code-client-go/internal/deepcode/mocks"
3131
"github.com/snyk/code-client-go/observability/mocks"
3232
)
3333

‎internal/bundle/mocks/bundle.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎internal/bundle/mocks/bundle_manager.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎deepcode/client.go renamed to ‎internal/deepcode/client.go

File renamed without changes.

‎deepcode/client_pact_test.go renamed to ‎internal/deepcode/client_pact_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ import (
2727
"github.com/stretchr/testify/assert"
2828

2929
confMocks "github.com/snyk/code-client-go/config/mocks"
30-
"github.com/snyk/code-client-go/deepcode"
3130
codeClientHTTP "github.com/snyk/code-client-go/http"
31+
"github.com/snyk/code-client-go/internal/deepcode"
3232
"github.com/snyk/code-client-go/internal/util"
3333
"github.com/snyk/code-client-go/internal/util/testutil"
3434
)

0 commit comments

Comments
 (0)