deepcode

Documentation

Overview

* © 2024 Snyk Limited All rights reserved. * * 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.

Index

• func NewSnykCodeClient(logger *zerolog.Logger, httpClient codeClientHTTP.HTTPClient, ...) *snykCodeClient
• type BundleFile
  • func BundleFileFrom(content []byte) BundleFile
• type BundleResponse
• type ExtendBundleRequest
• type FiltersResponse
• type SnykCodeClient

Functions

func NewSnykCodeClient

func NewSnykCodeClient(
	logger *zerolog.Logger,
	httpClient codeClientHTTP.HTTPClient,
	instrumentor observability.Instrumentor,
	errorReporter observability.ErrorReporter,
	config config.Config,
) *snykCodeClient

Types

type BundleFile

type BundleFile struct {
	Hash    string `json:"hash"`
	Content string `json:"content"`
}

func BundleFileFrom

func BundleFileFrom(content []byte) BundleFile

type BundleResponse

type BundleResponse struct {
	BundleHash   string   `json:"bundleHash"`
	MissingFiles []string `json:"missingFiles"`
}

type ExtendBundleRequest

type ExtendBundleRequest struct {
	Files        map[string]BundleFile `json:"files"`
	RemovedFiles []string              `json:"removedFiles,omitempty"`
}

type FiltersResponse

type FiltersResponse struct {
	ConfigFiles []string `json:"configFiles" pact:"min=1"`
	Extensions  []string `json:"extensions" pact:"min=1"`
}

type SnykCodeClient

type SnykCodeClient interface {
	GetFilters(ctx context.Context) (
		filters FiltersResponse,
		err error)

	CreateBundle(
		ctx context.Context,
		files map[string]string,
	) (newBundleHash string, missingFiles []string, err error)

	ExtendBundle(
		ctx context.Context,
		bundleHash string,
		files map[string]BundleFile,
		removedFiles []string,
	) (newBundleHash string, missingFiles []string, err error)
}