astore

README

TO UPLOAD A FILE:

curl --upload-file /etc/hosts 'https://storage.googleapis.com/test-onboarding/upload/0edc37244ea030da1d9e56998ef5af87?Expires=1593212002&GoogleAccessId=astore%40onboarder-281122.iam.gserviceaccount.com&Signature=rQcEAHg8wNMIJErrScDfHrJGGzhlOJP9KU%2F4wK3LBcTEhu%2BArrKb6G%2BLtl9RLAiKK1PpjhHPYKsphBQjQGlYV9Eh7Rjw7CNNkIXJfT9XA8n1OpY7KwNGjUx%2FISSsmg1LdI%2BkYeWi1oGDYh1fM2SkKq5MDlzOTuQXZTUiOMJT1AY%2FNrvjUYjF36QX9cnZtmlsQqQ24hZZY%2BwAM%2Fx8lBRXrqlwhecRDZGhPQnSzGqLP75KBkt7fcG9IdP3GuldM%2FSLpziUqb2SKqiqDtHeGAwi3IDdiYZ33T0S1NflncFjHpRhgKICA7oG8Xo9AivpWvjhnD0h1H%2BAZ%2F0nEHb1z%2BdRIA%3D%3D'

Documentation

Index

• Constants
• func Commit(t **datastore.Transaction) error
• func GenerateSid(rng *rand.Rand) (string, error)
• func GenerateUid(rng *rand.Rand) (string, error)
• func Rollback(t **datastore.Transaction)
• type Architecture
• type Artifact
  • func (af *Artifact) ToProto(arch string) *astore.Artifact
• type DownloadHandler
• type Flags
  • func DefaultFlags() *Flags
  • func (f *Flags) Register(set kflags.FlagSet, prefix string) *Flags
• type ListHandler
• type Modifier
  • func WithBucket(bucket string) Modifier
  • func WithCredentialsFile(path string) Modifier
  • func WithCredentialsJSON(json []byte) Modifier
  • func WithFlags(flags *Flags) Modifier
  • func WithLogger(log logger.Logger) Modifier
  • func WithProjectID(prid string) Modifier
  • func WithProjectIDFile(path string) Modifier
  • func WithProjectIDJSON(data []byte) Modifier
  • func WithPublishBaseURL(url string) Modifier
  • func WithSigningConfig(path string) Modifier
  • func WithSigningJSON(data []byte) Modifier
  • func WithValidity(d time.Duration) Modifier
• type Options
  • func DefaultOptions() Options
  • func (o *Options) ForSigning(method string) *storage.SignedURLOptions
• type PathElement
• type Published
  • func FromListRequest(req *astore.ListRequest, pub *Published) *Published
  • func FromRetrieveRequest(req *astore.RetrieveRequest, pub *Published) *Published
  • func (pub *Published) ToListRequest() *astore.ListRequest
  • func (pub *Published) ToRetrieveRequest() *astore.RetrieveRequest
• type Server
  • func New(rng *rand.Rand, mods ...Modifier) (*Server, error)
  • func (s *Server) Commit(ctx context.Context, req *astore.CommitRequest) (*astore.CommitResponse, error)
  • func (s *Server) Delete(ctx context.Context, request *astore.DeleteRequest) (*astore.DeleteResponse, error)
  • func (s *Server) DownloadArtifact(prefix string, ehandler DownloadHandler, w http.ResponseWriter, ...)
  • func (s *Server) DownloadPublished(prefix string, ehandler DownloadHandler, w http.ResponseWriter, ...)
  • func (s *Server) List(ctx context.Context, req *astore.ListRequest) (*astore.ListResponse, error)
  • func (s *Server) ListPublished(prefix string, ehandler ListHandler, w http.ResponseWriter, r *http.Request)
  • func (s *Server) Note(ctx context.Context, req *astore.NoteRequest) (*astore.NoteResponse, error)
  • func (s *Server) Publish(ctx context.Context, req *astore.PublishRequest) (*astore.PublishResponse, error)
  • func (s *Server) Retrieve(ctx context.Context, req *astore.RetrieveRequest) (*astore.RetrieveResponse, error)
  • func (s *Server) Store(ctx context.Context, req *astore.StoreRequest) (*astore.StoreResponse, error)
  • func (s *Server) Tag(ctx context.Context, req *astore.TagRequest) (*astore.TagResponse, error)
  • func (s *Server) Unpublish(ctx context.Context, req *astore.UnpublishRequest) (*astore.UnpublishResponse, error)

Constants

const KindArchitecture = "Arch"

const KindArtifact = "Artifact"

const KindPathElement = "Pel"

const KindPublished = "Pub"

Functions

func Commit

func Commit(t **datastore.Transaction) error

func GenerateSid

func GenerateSid(rng *rand.Rand) (string, error)

GenerateSid generates a path where to store the file.

func GenerateUid

func GenerateUid(rng *rand.Rand) (string, error)

GenerateUid generates a unique identifier for the metadata.

func Rollback

func Rollback(t **datastore.Transaction)

Types

type Architecture

type Architecture struct {
	Parent string

	Created time.Time
	Creator string
}

type Artifact

type Artifact struct {
	Uid string
	Sid string
	Tag []string

	MD5  []byte
	Size int64

	Parent  string
	Creator string
	Created time.Time
	Note    string `datastore:",noindex"`
}

func (*Artifact) ToProto

func (af *Artifact) ToProto(arch string) *astore.Artifact

type DownloadHandler

type DownloadHandler func(string, *astore.RetrieveResponse, error, http.ResponseWriter, *http.Request)

type Flags

type Flags struct {
	Bucket    string
	ProjectID string

	SignatureValidity time.Duration
	PublishBaseURL    string

	ProjectIDJSON       []byte
	SigningConfigJSON   []byte
	CredentialsFileJSON []byte
}

func DefaultFlags

func DefaultFlags() *Flags

func (*Flags) Register

func (f *Flags) Register(set kflags.FlagSet, prefix string) *Flags

type ListHandler

type ListHandler func(string, *astore.ListResponse, error, http.ResponseWriter, *http.Request)

type Modifier

type Modifier func(o *Options) error

func WithBucket

func WithBucket(bucket string) Modifier

func WithCredentialsFile

func WithCredentialsFile(path string) Modifier

func WithCredentialsJSON

func WithCredentialsJSON(json []byte) Modifier

func WithFlags

func WithFlags(flags *Flags) Modifier

func WithLogger

func WithLogger(log logger.Logger) Modifier

func WithProjectID

func WithProjectID(prid string) Modifier

func WithProjectIDFile

func WithProjectIDFile(path string) Modifier

func WithProjectIDJSON

func WithProjectIDJSON(data []byte) Modifier

func WithPublishBaseURL

func WithPublishBaseURL(url string) Modifier

func WithSigningConfig

func WithSigningConfig(path string) Modifier

func WithSigningJSON

func WithSigningJSON(data []byte) Modifier

func WithValidity

func WithValidity(d time.Duration) Modifier

type Options

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

func DefaultOptions

func DefaultOptions() Options

func (*Options) ForSigning

func (o *Options) ForSigning(method string) *storage.SignedURLOptions

type PathElement

type PathElement struct {
	Parent string

	Created time.Time
	Creator string
}

type Published

type Published struct {
	Parent  string
	Creator string
	Created time.Time

	// Fields from RetrieveRequest.
	Uid          string
	Path         string
	Architecture string

	// When converting this to a query, no tags vs empty tag array have different meanings:
	// The former indicates that the client specified no tags to filter by.
	// The latter indicates that the client is looking for artifacts with no tags assigned.
	//
	// We flatten the struct here, so we use a bool to differentiate between the two cases.
	HasTags bool
	Tag     []string
}

func FromListRequest

func FromListRequest(req *astore.ListRequest, pub *Published) *Published

func FromRetrieveRequest

func FromRetrieveRequest(req *astore.RetrieveRequest, pub *Published) *Published

func (*Published) ToListRequest

func (pub *Published) ToListRequest() *astore.ListRequest

func (*Published) ToRetrieveRequest

func (pub *Published) ToRetrieveRequest() *astore.RetrieveRequest

type Server

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

func New

func New(rng *rand.Rand, mods ...Modifier) (*Server, error)

func (*Server) Commit

func (s *Server) Commit(ctx context.Context, req *astore.CommitRequest) (*astore.CommitResponse, error)

func (*Server) Delete

func (s *Server) Delete(ctx context.Context, request *astore.DeleteRequest) (*astore.DeleteResponse, error)

func (*Server) DownloadArtifact

func (s *Server) DownloadArtifact(prefix string, ehandler DownloadHandler, w http.ResponseWriter, r *http.Request)

DownalodArtifact turns an http.Request into an astore.RetrieveRequest, executes it, and invokes the specified handler with the result.

func (*Server) DownloadPublished

func (s *Server) DownloadPublished(prefix string, ehandler DownloadHandler, w http.ResponseWriter, r *http.Request)

func (*Server) List

func (s *Server) List(ctx context.Context, req *astore.ListRequest) (*astore.ListResponse, error)

func (*Server) ListPublished

func (s *Server) ListPublished(prefix string, ehandler ListHandler, w http.ResponseWriter, r *http.Request)

func (*Server) Note

func (s *Server) Note(ctx context.Context, req *astore.NoteRequest) (*astore.NoteResponse, error)

func (*Server) Publish

func (s *Server) Publish(ctx context.Context, req *astore.PublishRequest) (*astore.PublishResponse, error)

func (*Server) Retrieve

func (s *Server) Retrieve(ctx context.Context, req *astore.RetrieveRequest) (*astore.RetrieveResponse, error)

func (*Server) Store

func (s *Server) Store(ctx context.Context, req *astore.StoreRequest) (*astore.StoreResponse, error)

func (*Server) Tag

func (s *Server) Tag(ctx context.Context, req *astore.TagRequest) (*astore.TagResponse, error)

func (*Server) Unpublish

func (s *Server) Unpublish(ctx context.Context, req *astore.UnpublishRequest) (*astore.UnpublishResponse, error)