cuetools

package

v0.1.9 Latest Latest Go to latest Published: Mar 24, 2024 License: Apache-2.0 Imports: 25 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/elastic/crossplane-function-cue

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func ExtractSchema(reader io.Reader, pkg string) ([]byte, error)
func GenerateOpenAPISchema(dir, pkg string) ([]byte, error)
func PackageScript(dir string, opts PackageScriptOpts) (_ []byte, finalErr error)
type OutputFormat
type PackageScriptOpts
type TestConfig
type Tester
- func NewTester(config TestConfig) (*Tester, error)
- func (t *Tester) Run() error

Constants ¶

View Source

const (
	ExternalDiffEnvVar = "XP_FUNCTION_CUE_DIFF"
)

Variables ¶

View Source

var TestOutput io.Writer = os.Stderr

Functions ¶

func ExtractSchema ¶

func ExtractSchema(reader io.Reader, pkg string) ([]byte, error)

ExtractSchema extracts an openAPI schema from a CRD/ XRD-like object and returns the equivalent cue types.

func GenerateOpenAPISchema ¶

func GenerateOpenAPISchema(dir, pkg string) ([]byte, error)

GenerateOpenAPISchema generates an openapi schema using the contents of the supplied directory and returns it prefixing it with a package declaration for the supplied package.

func PackageScript ¶

func PackageScript(dir string, opts PackageScriptOpts) (_ []byte, finalErr error)

PackageScript generates self-contained definitions from the supplied directory and returns cue code for an object with a _script property that contains the code as a string. The returned object has a package declaration for the package supplied.

Types ¶

type OutputFormat ¶

type OutputFormat string

const (
	FormatRaw OutputFormat = "raw"
	FormatCue OutputFormat = "cue"
)

type PackageScriptOpts ¶

type PackageScriptOpts struct {
	Format        OutputFormat // output format
	OutputPackage string       // package to declare for cue output
	VarName       string       // variable name to use for cue output, default _script
}

type TestConfig ¶

type TestConfig struct {
	Package     string
	TestPackage string
	TestTags    []string
	Debug       bool
}

type Tester ¶

type Tester struct {
	// contains filtered or unexported fields
}

func NewTester ¶

func NewTester(config TestConfig) (*Tester, error)

NewTester returns a test for the supplied configuration. It auto-discovers tags from test file names if needed.

func (*Tester) Run ¶

func (t *Tester) Run() error

Run runs all tests and returns a consolidated error.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL