Merge pull request #117 from docker/add-utm-tests

Added unit tests on snyk env var

Author: glours

internal/provider/snyk.go

@@ -21,6 +21,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"io"
 	"io/ioutil"
 	"os"
 	"os/exec"
@@ -45,12 +46,16 @@ type snykProvider struct {
 	flags   []string
 	auth    types.AuthConfig
 	context context.Context
+	out     io.Writer
+	err     io.Writer
 }
 
 // NewSnykProvider returns a Snyk implementation of scan provider
 func NewSnykProvider(ops ...SnykProviderOps) (Provider, error) {
 	provider := snykProvider{
 		flags: []string{"container", "test"},
+		out:   os.Stdout,
+		err:   os.Stderr,
 	}
 	for _, op := range ops {
 		if err := op(&provider); err != nil {
@@ -71,6 +76,15 @@ func WithContext(ctx context.Context) SnykProviderOps {
 	}
 }
 
+//WithStreams sets the out and err streams to be used by commands
+func WithStreams(out, err io.Writer) SnykProviderOps {
+	return func(provider *snykProvider) error {
+		provider.out = out
+		provider.err = err
+		return nil
+	}
+}
+
 // WithPath update the Snyk provider with the path from the configuration
 func WithPath(path string) SnykProviderOps {
 	return func(provider *snykProvider) error {
@@ -133,8 +147,8 @@ func (s *snykProvider) Authenticate(token string) error {
 		"SNYK_UTM_MEDIUM=Partner",
 		"SNYK_UTM_SOURCE=Docker",
 		"SNYK_UTM_CAMPAIGN=Docker-Desktop-2020")
-	cmd.Stdout = os.Stdout
-	cmd.Stderr = os.Stderr
+	cmd.Stdout = s.out
+	cmd.Stderr = s.err
 	return checkCommandErr(cmd.Run())
 }
 
@@ -150,8 +164,8 @@ func (s *snykProvider) Scan(image string) error {
 		cmd.Env = append(cmd.Env, fmt.Sprintf("SNYK_DOCKER_TOKEN=%s", token))
 	}
 
-	cmd.Stdout = os.Stdout
-	cmd.Stderr = os.Stderr
+	cmd.Stdout = s.out
+	cmd.Stderr = s.err
 	return checkCommandErr(cmd.Run())
 }
 

internal/provider/snyk_test.go

@@ -16,6 +16,87 @@
 
 package provider
 
+import (
+	"bytes"
+	"context"
+	"os"
+	"path/filepath"
+	"runtime"
+	"strings"
+	"testing"
+
+	"gotest.tools/v3/assert"
+	"gotest.tools/v3/env"
+	"gotest.tools/v3/fs"
+)
+
 var (
 	_ Provider = &snykProvider{}
 )
+
+const (
+	snykToken = "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
+)
+
+func TestSnykLoginEnvVars(t *testing.T) {
+	if runtime.GOOS == "windows" {
+		t.Skip("Can't run this test on windows")
+	}
+
+	provider, outStream := setupMockSnykBinary(t)
+
+	err := provider.Authenticate(snykToken)
+	assert.NilError(t, err)
+
+	// SNYK_INTEGRATION is always set
+	assert.Assert(t, strings.Contains(outStream.String(), "SNYK_INTEGRATION_NAME=DOCKER_DESKTOP"))
+	// NO_UPDATE_NOTIFIER disables node.js automatic update notification in console
+	assert.Assert(t, strings.Contains(outStream.String(), "NO_UPDATE_NOTIFIER=true"))
+	// SNYK_CFG_DISABLESUGGESTIONS removes user hints from snyk
+	assert.Assert(t, strings.Contains(outStream.String(), "SNYK_CFG_DISABLESUGGESTIONS=true"))
+	// Check UTMs variables
+	assert.Assert(t, strings.Contains(outStream.String(), "SNYK_UTM_MEDIUM=Partner"))
+	assert.Assert(t, strings.Contains(outStream.String(), "SNYK_UTM_SOURCE=Docker"))
+	assert.Assert(t, strings.Contains(outStream.String(), "SNYK_UTM_CAMPAIGN=Docker-Desktop-2020"))
+}
+
+func TestSnykScanEnvVars(t *testing.T) {
+	if runtime.GOOS == "windows" {
+		t.Skip("Can't run this test on windows")
+	}
+
+	// Create Snyk config file with token
+	tempDir := fs.NewDir(t, t.Name(),
+		fs.WithDir(".config",
+			fs.WithDir("configstore",
+				fs.WithFile("snyk.json", `{"api":"`+snykToken+`"}`))))
+	defer tempDir.Remove()
+	defer env.Patch(t, "HOME", tempDir.Path())()
+
+	provider, outStream := setupMockSnykBinary(t)
+
+	err := provider.Scan("image")
+	assert.NilError(t, err)
+
+	// SNYK_INTEGRATION is always set
+	assert.Assert(t, strings.Contains(outStream.String(), "SNYK_INTEGRATION_NAME=DOCKER_DESKTOP"))
+	// NO_UPDATE_NOTIFIER disables node.js automatic update notification in console
+	assert.Assert(t, strings.Contains(outStream.String(), "NO_UPDATE_NOTIFIER=true"))
+	// SNYK_CFG_DISABLESUGGESTIONS removes user hints from snyk
+	assert.Assert(t, strings.Contains(outStream.String(), "SNYK_CFG_DISABLESUGGESTIONS=true"))
+}
+
+func setupMockSnykBinary(t *testing.T) (Provider, *bytes.Buffer) {
+	pwd, err := os.Getwd()
+	assert.NilError(t, err)
+	snykPath := filepath.Join(pwd, "testdata", "snyk")
+	outStream := bytes.NewBuffer(nil)
+	errStream := bytes.NewBuffer(nil)
+
+	provider, err := NewSnykProvider(
+		WithPath(snykPath),
+		WithContext(context.Background()),
+		WithStreams(outStream, errStream))
+	assert.NilError(t, err)
+	return provider, outStream
+}

internal/provider/testdata/snyk

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+#   Copyright The Compose Specification Authors.
+
+#   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.
+
+env