codeclient

README

code-client-go

A library that exposes scanning capabilities for Snyk Code that can be used in the Snyk CLI as well as Snyk IDE plugins using the Snyk Language Server.

Installation

$ go get github.com/snyk/code-client-go

Usage

HTTP Client

Use the HTTP client to make HTTP requests with configured retriable codes and authorisation headers for Snyk Rest APIs.

Implement the github.com/snyk/code-client-go/http.Config interface to configure the Snyk Code API client from applications.

Provide a net/http.Client factory to customize the underlying HTTP protocol behavior (timeouts, etc).

import (
    "net/http"

    "github.com/rs/zerolog"
    codehttp "github.com/snyk/code-client-go/http"
)

logger := zerlog.NewLogger(...)
config := newConfigForMyApp()
httpClient := codehttp.NewHTTPClient(logger, config, func() *http.Client { return http.DefaultClient }, codeInstrumentor, codeErrorReporter)

The HTTP client exposes a DoCall function.

Configuration

Implement the http.Config interface and to configure the Snyk Code API client from applications.

Snyk Code Client

Use the Snyk Code Client to make calls to the DeepCode API using the httpClient HTTP client created above.

snykCode := deepcode.NewSnykCodeClient(logger, httpClient, testutil.NewTestInstrumentor())

The Snyk Code Client exposes the following functions:

• GetFilters
• CreateBundle
• ExtendBundle

Bundle Manager

Use the Bundle Manager to create bundles using the snykCode Snyk Code Client created above and then to extend it by uploading more files to it.

bundleManager := bundle.NewBundleManager(snykCode, testutil.NewTestInstrumentor(), testutil.NewTestCodeInstrumentor())

The Bundle Manager exposes the following functions:

• Create
• Upload

Code Scanner

Use the Code Scanner to trigger a scan for a Snyk Code workspace using the Bundle Manager created above:

codeScanner := codeclient.NewCodeScanner(
    bundleManager,
    testutil.NewTestInstrumentor(),
    testutil.NewTestCodeInstrumentor(),
    testutils.NewTestAnalytics(),
)

The Code Scanner exposes a UploadAndAnalyze function.

Observability

Under ./observability we have defined some observability interfaces which allows consumers of the library to inject their own observability implementations as long as they follow the defined interfaces.

Documentation

Index

• func NewCodeScanner(bundleManager bundle.BundleManager, instrumentor observability.Instrumentor, ...) *codeScanner
• type CodeScanner

Functions

func NewCodeScanner

func NewCodeScanner(
	bundleManager bundle.BundleManager,
	instrumentor observability.Instrumentor,
	errorReporter observability.ErrorReporter,
	logger *zerolog.Logger,
) *codeScanner

NewCodeScanner creates a Code Scanner which can be used to trigger Snyk Code on a folder.

Types

type CodeScanner

type CodeScanner interface {
	UploadAndAnalyze(
		ctx context.Context,
		host string,
		path string,
		files <-chan string,
		changedFiles map[string]bool,
	) (*sarif.SarifResponse, bundle.Bundle, error)
}