specter

package module

Go to main page

Versions in this module

v0

v0.0.2

Aug 29, 2024

Changes in this version

+ const DefaultJSONArtifactRegistryFileName

+ const LinterResultArtifactID

+ const ResolvedDependenciesArtifactID

type Artifact

+ ID func() ArtifactID

+ type ArtifactID string

type ArtifactProcessingContext

+ ArtifactRegistry ProcessorArtifactRegistry

type ArtifactRegistry

+ Add func(processorName string, e ArtifactRegistryEntry) error

+ FindAll func(processorName string) ([]ArtifactRegistryEntry, error)

+ FindByID func(processorName string, artifactID ArtifactID) (entry ArtifactRegistryEntry, found bool, err error)

+ Remove func(processorName string, artifactID ArtifactID) error

+ type ArtifactRegistryEntry struct

+ ArtifactID ArtifactID

+ Metadata map[string]any

type FileArtifact

+ FileMode os.FileMode

+ WriteMode WriteMode

+ func NewDirectoryArtifact(path string, fileMode os.FileMode, writeMode WriteMode) *FileArtifact

+ func (a FileArtifact) ID() ArtifactID

+ func (a FileArtifact) IsDir() bool

+ type FileArtifactProcessor struct

+ FileSystem FileSystem

+ func (p FileArtifactProcessor) Name() string

+ func (p FileArtifactProcessor) Process(ctx ArtifactProcessingContext) error

type FileSystem

+ Rel func(basePath, targetPath string) (string, error)

type FileSystemLoader

+ func NewFileSystemLoader(fs FileSystem) *FileSystemLoader

type InMemoryArtifactRegistry

+ func (r *InMemoryArtifactRegistry) Add(processorName string, e ArtifactRegistryEntry) error

+ func (r *InMemoryArtifactRegistry) FindAll(processorName string) ([]ArtifactRegistryEntry, error)

+ func (r *InMemoryArtifactRegistry) FindByID(processorName string, artifactID ArtifactID) (entry ArtifactRegistryEntry, found bool, err error)

+ func (r *InMemoryArtifactRegistry) Remove(processorName string, artifactID ArtifactID) error

type JSONArtifactRegistry

+ Entries map[string][]JsonArtifactRegistryEntry

+ func (r *JSONArtifactRegistry) Add(processorName string, e ArtifactRegistryEntry) error

+ func (r *JSONArtifactRegistry) FindAll(processorName string) ([]ArtifactRegistryEntry, error)

+ func (r *JSONArtifactRegistry) FindByID(processorName string, artifactID ArtifactID) (ArtifactRegistryEntry, bool, error)

+ func (r *JSONArtifactRegistry) Remove(processorName string, artifactID ArtifactID) error

+ type JsonArtifactRegistryEntry struct

+ ArtifactID ArtifactID

+ Metadata map[string]any

type LinterResultSet

+ func (s LinterResultSet) ID() ArtifactID

type LocalFileSystem

+ func (l LocalFileSystem) Rel(basePath, targetPath string) (string, error)

type NoopArtifactRegistry

+ func (n NoopArtifactRegistry) Add(processorName string, e ArtifactRegistryEntry) error

+ func (n NoopArtifactRegistry) FindAll(processorName string) ([]ArtifactRegistryEntry, error)

+ func (n NoopArtifactRegistry) FindByID(processorName string, artifactID ArtifactID) (_ ArtifactRegistryEntry, _ bool, _ error)

+ func (n NoopArtifactRegistry) Remove(processorName string, artifactID ArtifactID) error

type Option

+ func WithJSONArtifactRegistry(fileName string, fs FileSystem) Option

+ type ProcessorArtifactRegistry struct

+ func (n ProcessorArtifactRegistry) Add(artifactID ArtifactID, metadata map[string]any) error

+ func (n ProcessorArtifactRegistry) FindAll() ([]ArtifactRegistryEntry, error)

+ func (n ProcessorArtifactRegistry) FindByID(artifactID ArtifactID) (_ ArtifactRegistryEntry, _ bool, _ error)

+ func (n ProcessorArtifactRegistry) Remove(artifactID ArtifactID) error

type ResolvedDependencies

+ func (r ResolvedDependencies) ID() ArtifactID

+ type WriteMode string

+ const DefaultWriteMode

+ const RecreateMode

+ const WriteOnceMode

v0.0.1

Aug 22, 2024

Changes in this version

+ const InvalidHCLErrorCode

+ const LintingErrorCode

+ const LintingProcessingContextArtifactName

+ const ResolvedDependencyContextArtifactName

+ const Unknown

+ const UnsupportedSourceErrorCode

+ const WriteFileArtifactsProcessorErrorCode

+ func CheckContextDone(ctx context.Context) error

+ func GetContextArtifact[T any](ctx ProcessingContext, name string) (v T)

+ func MapSpecGroup[T any](g SpecificationGroup, p func(s Specification) T) []T

+ type Artifact struct

+ Name string

+ Value any

+ type ArtifactProcessingContext struct

+ Artifacts []Artifact

+ Logger Logger

+ Specifications SpecificationGroup

+ func (c *ArtifactProcessingContext) AddToRegistry(artifactName string)

+ func (c *ArtifactProcessingContext) RegistryArtifacts() []string

+ func (c *ArtifactProcessingContext) RemoveFromRegistry(artifactName string)

+ type ArtifactProcessor interface

+ Name func() string

+ Process func(ctx ArtifactProcessingContext) error

+ type ArtifactRegistry interface

+ AddArtifact func(processorName string, artifactName string)

+ Artifacts func(processorName string) []string

+ Load func() error

+ RemoveArtifact func(processorName string, artifactName string)

+ Save func() error

+ type AttributeType string

+ type AttributeValue interface

+ String func() string

+ type DefaultLogger struct

+ func NewDefaultLogger(c DefaultLoggerConfig) *DefaultLogger

+ func (l *DefaultLogger) Error(msg string)

+ func (l *DefaultLogger) Info(msg string)

+ func (l *DefaultLogger) Log(msg string)

+ func (l *DefaultLogger) Success(msg string)

+ func (l *DefaultLogger) Trace(msg string)

+ func (l *DefaultLogger) Warning(msg string)

+ type DefaultLoggerConfig struct

+ DisableColors bool

+ Writer io.Writer

+ type DependencyProvider interface

+ Provide func(s Specification) []SpecificationName

+ Supports func(s Specification) bool

+ type DependencyResolutionProcessor struct

+ func NewDependencyResolutionProcessor(providers ...DependencyProvider) *DependencyResolutionProcessor

+ func (p DependencyResolutionProcessor) Name() string

+ func (p DependencyResolutionProcessor) Process(ctx ProcessingContext) ([]Artifact, error)

+ type DirectoryArtifact struct

+ Mode os.FileMode

+ Path string

+ type ExecutionMode string

+ const FullMode

+ const LintMode

+ const PreviewMode

+ type FileArtifact struct

+ Data []byte

+ Mode os.FileMode

+ Path string

+ type FileSystem interface

+ Abs func(location string) (string, error)

+ Mkdir func(dirPath string, mode fs.FileMode) error

+ ReadFile func(filePath string) ([]byte, error)

+ Remove func(path string) error

+ StatPath func(location string) (os.FileInfo, error)

+ WalkDir func(dirPath string, f func(path string, d fs.DirEntry, err error) error) error

+ WriteFile func(path string, data []byte, perm fs.FileMode) error

+ type FileSystemLoader struct

+ func NewLocalFileSourceLoader() FileSystemLoader

+ func (l FileSystemLoader) Load(location string) ([]Source, error)

+ func (l FileSystemLoader) Supports(target string) bool

+ type GenericSpecAttribute struct

+ Name string

+ Value AttributeValue

+ type GenericSpecification struct

+ Attributes []GenericSpecAttribute

+ func NewGenericSpecification(name SpecificationName, typ SpecificationType, source Source) *GenericSpecification

+ func (s *GenericSpecification) Attribute(name string) *GenericSpecAttribute

+ func (s *GenericSpecification) Description() string

+ func (s *GenericSpecification) HasAttribute(name string) bool

+ func (s *GenericSpecification) Name() SpecificationName

+ func (s *GenericSpecification) SetSource(src Source)

+ func (s *GenericSpecification) Source() Source

+ func (s *GenericSpecification) Type() SpecificationType

+ type GenericValue struct

+ func (d GenericValue) String() string

+ type HCLFileConfig interface

+ Specifications func() []Specification

+ type HCLGenericSpecLoader struct

+ func NewHCLGenericSpecLoader() *HCLGenericSpecLoader

+ func (l HCLGenericSpecLoader) Load(s Source) ([]Specification, error)

+ func (l HCLGenericSpecLoader) SupportsSource(s Source) bool

+ type HCLSpecLoader struct

+ func NewHCLFileConfigSpecLoader(fileConfigProvider HCLSpecLoaderFileConfigurationProvider) *HCLSpecLoader

+ func (l HCLSpecLoader) Load(s Source) ([]Specification, error)

+ func (l HCLSpecLoader) SupportsSource(s Source) bool

+ type HCLSpecLoaderFileConfigurationProvider func() HCLFileConfig

+ type HCLVariableConfig struct

+ Description string

+ Name string

+ Value cty.Value

+ type HasDependencies interface

+ Dependencies func() []SpecificationName

+ type HasDependenciesProvider struct

+ func (h HasDependenciesProvider) Provide(s Specification) []SpecificationName

+ func (h HasDependenciesProvider) Supports(s Specification) bool

+ type HasVersion interface

+ Version func() SpecificationVersion

+ type InMemoryArtifactRegistry struct

+ ArtifactMap map[string][]string

+ func (r *InMemoryArtifactRegistry) AddArtifact(processorName string, artifactName string)

+ func (r *InMemoryArtifactRegistry) Artifacts(processorName string) []string

+ func (r *InMemoryArtifactRegistry) Load() error

+ func (r *InMemoryArtifactRegistry) RemoveArtifact(processorName string, artifactName string)

+ func (r *InMemoryArtifactRegistry) Save() error

+ type JSONArtifactRegistry struct

+ ArtifactMap map[string]*JSONArtifactRegistryProcessor

+ CurrentTimeProvider func() time.Time

+ FilePath string

+ FileSystem FileSystem

+ GeneratedAt time.Time

+ func NewJSONArtifactRegistry(fileName string, fs FileSystem) *JSONArtifactRegistry

+ func (r *JSONArtifactRegistry) AddArtifact(processorName string, artifactName string)

+ func (r *JSONArtifactRegistry) Artifacts(processorName string) []string

+ func (r *JSONArtifactRegistry) Load() error

+ func (r *JSONArtifactRegistry) RemoveArtifact(processorName string, artifactName string)

+ func (r *JSONArtifactRegistry) Save() error

+ type JSONArtifactRegistryProcessor struct

+ Artifacts []string

+ type LinterResult struct

+ Message string

+ Severity LinterResultSeverity

+ type LinterResultSet []LinterResult

+ func GetLintingResultsFromContext(ctx ProcessingContext) LinterResultSet

+ func (s LinterResultSet) Errors() errors.Group

+ func (s LinterResultSet) HasErrors() bool

+ func (s LinterResultSet) HasWarnings() bool

+ func (s LinterResultSet) Warnings() LinterResultSet

+ type LinterResultSeverity string

+ const ErrorSeverity

+ const WarningSeverity

+ type LintingProcessor struct

+ func NewLintingProcessor(linters ...SpecificationLinter) *LintingProcessor

+ func (l LintingProcessor) Name() string

+ func (l LintingProcessor) Process(ctx ProcessingContext) (artifacts []Artifact, err error)

+ type LocalFileSystem struct

+ func (l LocalFileSystem) Abs(location string) (string, error)

+ func (l LocalFileSystem) Mkdir(dirPath string, mode fs.FileMode) error

+ func (l LocalFileSystem) ReadFile(filePath string) ([]byte, error)

+ func (l LocalFileSystem) Remove(path string) error

+ func (l LocalFileSystem) StatPath(location string) (os.FileInfo, error)

+ func (l LocalFileSystem) WalkDir(dirPath string, f func(path string, d fs.DirEntry, err error) error) error

+ func (l LocalFileSystem) WriteFile(path string, data []byte, perm fs.FileMode) error

+ type Logger interface

+ Error func(msg string)

+ Info func(msg string)

+ Success func(msg string)

+ Trace func(msg string)

+ Warning func(msg string)

+ type MakeDirectoryArtifactsProcessor struct

+ FileSystem FileSystem

+ func (p MakeDirectoryArtifactsProcessor) Name() string

+ func (p MakeDirectoryArtifactsProcessor) Process(ctx ArtifactProcessingContext) error

+ type NoopArtifactRegistry struct

+ func (n NoopArtifactRegistry) AddArtifact(processorName string, artifactName string)

+ func (n NoopArtifactRegistry) Artifacts(processorName string) []string

+ func (n NoopArtifactRegistry) Load() error

+ func (n NoopArtifactRegistry) RemoveArtifact(processorName string, artifactName string)

+ func (n NoopArtifactRegistry) Save() error

+ type ObjectValue struct

+ Attributes []GenericSpecAttribute

+ Type AttributeType

+ func (o ObjectValue) String() string

+ type Option func(s *Specter)

+ func WithArtifactProcessors(processors ...ArtifactProcessor) Option

+ func WithArtifactRegistry(r ArtifactRegistry) Option

+ func WithDefaultLogger() Option

+ func WithExecutionMode(m ExecutionMode) Option

+ func WithLoaders(loaders ...SpecificationLoader) Option

+ func WithLogger(l Logger) Option

+ func WithProcessors(processors ...SpecificationProcessor) Option

+ func WithSourceLoaders(loaders ...SourceLoader) Option

+ type ProcessingContext struct

+ Artifacts []Artifact

+ Logger Logger

+ Specifications SpecificationGroup

+ func (c ProcessingContext) Artifact(artifactName string) Artifact

+ type ResolvedDependencies SpecificationGroup

+ func GetResolvedDependenciesFromContext(ctx ProcessingContext) ResolvedDependencies

+ type RunResult struct

+ Artifacts []Artifact

+ Sources []Source

+ Specification []Specification

+ Stats Stats

+ type Source struct

+ Data []byte

+ Format SourceFormat

+ Location string

+ type SourceFormat string

+ const HCLSourceFormat

+ type SourceLoader interface

+ Load func(location string) ([]Source, error)

+ Supports func(location string) bool

+ type Specification interface

+ Description func() string

+ Name func() SpecificationName

+ SetSource func(s Source)

+ Source func() Source

+ Type func() SpecificationType

+ type SpecificationGroup []Specification

+ func NewSpecGroup(s ...Specification) SpecificationGroup

+ func (g SpecificationGroup) Exclude(p func(s Specification) bool) SpecificationGroup

+ func (g SpecificationGroup) ExcludeNames(names ...SpecificationName) SpecificationGroup

+ func (g SpecificationGroup) ExcludeType(t SpecificationType) SpecificationGroup

+ func (g SpecificationGroup) Merge(group SpecificationGroup) SpecificationGroup

+ func (g SpecificationGroup) Select(p func(s Specification) bool) SpecificationGroup

+ func (g SpecificationGroup) SelectName(t SpecificationName) Specification

+ func (g SpecificationGroup) SelectNames(names ...SpecificationName) SpecificationGroup

+ func (g SpecificationGroup) SelectType(t SpecificationType) SpecificationGroup

+ type SpecificationLinter interface

+ Lint func(specifications SpecificationGroup) LinterResultSet

+ func HasVersionMustHaveAVersionLinter(severity LinterResultSeverity) SpecificationLinter

+ type SpecificationLinterFunc func(specifications SpecificationGroup) LinterResultSet

+ func CompositeSpecificationLinter(linters ...SpecificationLinter) SpecificationLinterFunc

+ func SpecificationMustNotHaveUndefinedNames(severity LinterResultSeverity) SpecificationLinterFunc

+ func SpecificationsDescriptionsMustEndWithPeriod(severity LinterResultSeverity) SpecificationLinterFunc

+ func SpecificationsDescriptionsMustStartWithACapitalLetter(severity LinterResultSeverity) SpecificationLinterFunc

+ func SpecificationsMustHaveDescriptionAttribute(severity LinterResultSeverity) SpecificationLinterFunc

+ func SpecificationsMustHaveUniqueNames(severity LinterResultSeverity) SpecificationLinterFunc

+ func (l SpecificationLinterFunc) Lint(specifications SpecificationGroup) LinterResultSet

+ type SpecificationLoader interface

+ Load func(s Source) ([]Specification, error)

+ SupportsSource func(s Source) bool

+ type SpecificationName string

+ const UndefinedSpecificationName

+ type SpecificationProcessor interface

+ Name func() string

+ Process func(ctx ProcessingContext) ([]Artifact, error)

+ type SpecificationType string

+ type SpecificationVersion string

+ type Specter struct

+ ArtifactProcessors []ArtifactProcessor

+ ArtifactRegistry ArtifactRegistry

+ ExecutionMode ExecutionMode

+ Loaders []SpecificationLoader

+ Logger Logger

+ Processors []SpecificationProcessor

+ SourceLoaders []SourceLoader

+ func New(opts ...Option) *Specter

+ func (s Specter) LoadSources(ctx context.Context, sourceLocations []string) ([]Source, error)

+ func (s Specter) LoadSpecifications(ctx context.Context, sources []Source) ([]Specification, error)

+ func (s Specter) ProcessArtifacts(ctx context.Context, specifications []Specification, artifacts []Artifact) error

+ func (s Specter) ProcessSpecifications(ctx context.Context, specs []Specification) ([]Artifact, error)

+ func (s Specter) Run(ctx context.Context, sourceLocations []string) (RunResult, error)

+ type Stats struct

+ EndedAt time.Time

+ NbArtifacts int

+ NbSourceLocations int

+ NbSources int

+ NbSpecifications int

+ StartedAt time.Time

+ func (s Stats) ExecutionTime() time.Duration

+ type WriteFileArtifactProcessor struct

+ FileSystem FileSystem

+ func (p WriteFileArtifactProcessor) Name() string

+ func (p WriteFileArtifactProcessor) Process(ctx ArtifactProcessingContext) error

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