cache

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 18, 2021 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Copyright 2020 Fugue, Inc.

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

Constants

View Source
const (
	// ReadWrite is the default cache mode
	ReadWrite = "read-write"

	// WriteOnly mode is used to write to the cache but not read from it
	WriteOnly = "write-only"

	// Disabled mode bypasses all cache interactions
	Disabled = "disabled"
)
View Source
const CacheMiss = Error("Item not found in cache")

CacheMiss indicates the cache did not contain a match

Variables

This section is empty.

Functions

func HashCommand added in v0.2.0

func HashCommand(cmd *project.Command) (string, error)

HashCommand returns a SHA1 hash of the command configuration

func HashFile

func HashFile(filePath string) (string, error)

HashFile returns the SHA1 hash of file contents

func HashString

func HashString(s string) (string, error)

HashString returns the SHA1 hash of a string

func MapKeys

func MapKeys(m map[string]string) (result []string)

MapKeys returns a sorted slice containing all keys from the given map

func NewMiddleware

func NewMiddleware(s store.Store, user, mode string) project.RunnerBuilder

NewMiddleware returns caching middleware

Types

type Cache

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

Cache used to determine rule keys

func New

func New(s store.Store) *Cache

New returns a cache

func (*Cache) Key

func (c *Cache) Key(ctx context.Context, r *project.Rule) (*Key, error)

Key returns a struct of information that uniquely identifies the Rule's inputs and configuration. This used to store Rule outputs in the cache.

func (*Cache) Read

func (c *Cache) Read(ctx context.Context, r *project.Rule) ([]string, error)

Read rule outputs from the cache

func (*Cache) Write

func (c *Cache) Write(ctx context.Context, r *project.Rule) ([]string, error)

Write rule outputs to the cache

type Entry

type Entry struct {
	Name string `json:"name"`
	Hash string `json:"hash"`
}

Entry carries the name and hash for one item within a Key

type Error

type Error string

Error is used to handle cache misses and the like

func (Error) Error

func (e Error) Error() string

type Key

type Key struct {
	Project     string   `json:"project"`
	Component   string   `json:"component"`
	Rule        string   `json:"rule"`
	Image       string   `json:"image"`
	OutputCount int      `json:"output_count"`
	Inputs      []*Entry `json:"inputs"`
	Deps        []*Entry `json:"deps"`
	Env         []*Entry `json:"env"`
	Toolchain   []*Entry `json:"toolchain"`
	Version     string   `json:"version"`
	Commands    []string `json:"commands"`
	Native      bool     `json:"native,omitempty"`
	// contains filtered or unexported fields
}

Key contains information used to build a key

func (*Key) Compute

func (k *Key) Compute() error

Compute determines the hash for this key

func (*Key) String

func (k *Key) String() string

String returns the key as a hexadecimal string

Jump to

Keyboard shortcuts

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