githubtesting

Documentation

Overview

Package githubtesting provides testing functionality for GitHub.

Index

• type ArchiveReader
  • func NewArchiveReader(logger *slog.Logger, storageosProvider storageos.Provider, ...) ArchiveReader

Types

type ArchiveReader

type ArchiveReader interface {
	// GetArchive gets the GitHub archive and untars it to the output directory path.
	//
	// The root directory within the tarball is stripped.
	// If the directory already exists, this is a no-op.
	//
	// Uses file locking to make sure the no-op works properly across multiple process invocations,
	// which is needed for example with go test.
	// This is also thread-safe.
	//
	// Only use for testing.
	GetArchive(
		ctx context.Context,
		outputDirPath string,
		owner string,
		repository string,
		ref string,
	) error
}

ArchiveReader reads GitHub archives.

func NewArchiveReader

func NewArchiveReader(
	logger *slog.Logger,
	storageosProvider storageos.Provider,
	httpClient *http.Client,
) ArchiveReader

NewArchiveReader returns a new ArchiveReader.