contract

Documentation

Overview

Package contract provides the implementation of the contract service

Index

• func AppendInParameters(parameters []models.Parameter, inParameters map[string]string, ...) []models.Parameter
• func ExtractIdentifiers(path string) []string
• func ExtractQueryParams(rawURL string) (map[string]string, error)
• func ExtractURLPath(URL string) (string, string)
• func ExtractVariableTypes(obj map[string]interface{}) map[string]map[string]interface{}
• func GenerateDummyNamesForIdentifiers(identifiers []string) map[string]string
• func GenerateHeader(header map[string]string) []models.Parameter
• func GenerateResponse(response Response) map[string]models.ResponseItem
• func ReplacePathIdentifiers(path string, dummyNames map[string]string) string
• type MockDB
• type OpenAPIDB
• type Response
• type Service
  • func New(logger *zap.Logger, testDB TestDB, mockDB MockDB, openAPIDB OpenAPIDB, ...) Service
• type TestDB

Functions

func AppendInParameters

func AppendInParameters(parameters []models.Parameter, inParameters map[string]string, paramType string) []models.Parameter

func ExtractIdentifiers

func ExtractIdentifiers(path string) []string

ExtractIdentifiers extracts numeric identifiers (integers or floats) from the path.

func ExtractQueryParams

func ExtractQueryParams(rawURL string) (map[string]string, error)

ExtractQueryParams extracts the query parameters and their names from the URL.

func ExtractURLPath

func ExtractURLPath(URL string) (string, string)

func ExtractVariableTypes

func ExtractVariableTypes(obj map[string]interface{}) map[string]map[string]interface{}

ExtractVariableTypes returns the type of each variable in the object.

func GenerateDummyNamesForIdentifiers

func GenerateDummyNamesForIdentifiers(identifiers []string) map[string]string

GenerateDummyNamesForIdentifiers generates dummy names for the path identifiers.

func GenerateHeader

func GenerateHeader(header map[string]string) []models.Parameter

func GenerateResponse

func GenerateResponse(response Response) map[string]models.ResponseItem

func ReplacePathIdentifiers

func ReplacePathIdentifiers(path string, dummyNames map[string]string) string

ReplacePathIdentifiers replaces numeric identifiers in the path with their corresponding dummy names.

Types

type MockDB

type MockDB interface {
	GetHTTPMocks(ctx context.Context, testSetID string, mockPath string, mockFileName string) ([]*models.HTTPDoc, error)
}

type OpenAPIDB

type OpenAPIDB interface {
	GetTestCasesSchema(ctx context.Context, testSetID string, testPath string) ([]*models.OpenAPI, error)
	GetMocksSchemas(ctx context.Context, testSetID string, mockPath string, mockFileName string) ([]*models.OpenAPI, error)
	WriteSchema(ctx context.Context, logger *zap.Logger, outputPath, name string, openapi models.OpenAPI, isAppend bool) error
	ChangePath(path string)
}

type Response

type Response struct {
	Code    int
	Message string
	Types   map[string]map[string]interface{}
	Body    map[string]interface{}
}

type Service

type Service interface {
	Generate(ctx context.Context, checkConfig bool) error
	Download(ctx context.Context, checkConfig bool) error
	Validate(ctx context.Context) error
}

Service defines the contract service interface

func New

func New(logger *zap.Logger, testDB TestDB, mockDB MockDB, openAPIDB OpenAPIDB, config *config.Config) Service

type TestDB

type TestDB interface {
	GetAllTestSetIDs(ctx context.Context) ([]string, error)
	GetTestCases(ctx context.Context, testSetID string) ([]*models.TestCase, error)
	ChangePath(path string)
}