workspace

Documentation

Overview

Package workspace contains functionality to manage a user's local workspace. This includes creating an application directory, reading and writing a summary file to associate the workspace with the application, and managing infrastructure-as-code files. The typical workspace will be structured like:

.
├── copilot                        (application directory)
│   ├── .workspace                 (workspace summary)
│   ├── my-service
│   │   └── manifest.yml           (service manifest)
|   |   environments
|   |   └── test
│   │       └── manifest.yml       (environment manifest for the environment test)
│   ├── buildspec.yml              (legacy buildspec for the pipeline's build stage)
│   ├── pipeline.yml               (legacy pipeline manifest)
│   ├── pipelines
│   │   ├── pipeline-app-beta
│   │   │   ├── buildspec.yml      (buildspec for the pipeline 'pipeline-app-beta')
│   ┴   ┴   └── manifest.yml       (pipeline manifest for the pipeline 'pipeline-app-beta')
└── my-service-src                 (customer service code)

Index

• Constants
• Variables
• func IsInGitRepository(fs FileStat) bool
• type EnvironmentManifest
• type ErrFileExists
  • func (e *ErrFileExists) Error() string
• type ErrFileNotExists
  • func (e *ErrFileNotExists) Error() string
• type ErrWorkspaceNotFound
  • func (e *ErrWorkspaceNotFound) Error() string
• type FileStat
• type PipelineManifest
• type Summary
• type WorkloadManifest
  • func (w WorkloadManifest) WorkloadType() (string, error)
• type Workspace
  • func New() (*Workspace, error)
  • func (ws *Workspace) Create(appName string) error
  • func (ws *Workspace) DeleteWorkspaceFile() error
  • func (ws *Workspace) ListDockerfiles() ([]string, error)
  • func (ws *Workspace) ListEnvironments() ([]string, error)
  • func (ws *Workspace) ListJobs() ([]string, error)
  • func (ws *Workspace) ListPipelines() ([]PipelineManifest, error)
  • func (ws *Workspace) ListServices() ([]string, error)
  • func (ws *Workspace) ListWorkloads() ([]string, error)
  • func (ws *Workspace) Path() (string, error)
  • func (ws *Workspace) ReadAddon(svc, fname string) ([]byte, error)
  • func (ws *Workspace) ReadAddonsDir(svcName string) ([]string, error)
  • func (ws *Workspace) ReadEnvironmentManifest(mftDirName string) (EnvironmentManifest, error)
  • func (ws *Workspace) ReadPipelineManifest(path string) (*manifest.Pipeline, error)
  • func (ws *Workspace) ReadWorkloadManifest(mftDirName string) (WorkloadManifest, error)
  • func (ws *Workspace) Rel(path string) (string, error)
  • func (ws *Workspace) Summary() (*Summary, error)
  • func (ws *Workspace) WriteAddon(content encoding.BinaryMarshaler, svc, name string) (string, error)
  • func (ws *Workspace) WriteEnvironmentManifest(marshaler encoding.BinaryMarshaler, name string) (string, error)
  • func (ws *Workspace) WriteJobManifest(marshaler encoding.BinaryMarshaler, name string) (string, error)
  • func (ws *Workspace) WritePipelineBuildspec(marshaler encoding.BinaryMarshaler, name string) (string, error)
  • func (ws *Workspace) WritePipelineManifest(marshaler encoding.BinaryMarshaler, name string) (string, error)
  • func (ws *Workspace) WriteServiceManifest(marshaler encoding.BinaryMarshaler, name string) (string, error)

Constants

const (
	// CopilotDirName is the name of the directory where generated infrastructure code for an application will be stored.
	CopilotDirName = "copilot"
	// SummaryFileName is the name of the file that is associated with the application.
	SummaryFileName = ".workspace"
)

Variables

var ErrNoPipelineInWorkspace = errors.New("no pipeline manifest found in the workspace")

ErrNoPipelineInWorkspace means there was no pipeline manifest in the workspace dir.

Functions

func IsInGitRepository

func IsInGitRepository(fs FileStat) bool

IsInGitRepository returns true if the current working directory is a git repository.

Types

type EnvironmentManifest

type EnvironmentManifest []byte

EnvironmentManifest represents raw local environment manifest.

type ErrFileExists

type ErrFileExists struct {
	FileName string
}

ErrFileExists means we tried to create an existing file.

func (*ErrFileExists) Error

func (e *ErrFileExists) Error() string

type ErrFileNotExists

type ErrFileNotExists struct {
	FileName string
}

ErrFileNotExists means we tried to read a non-existing file.

func (*ErrFileNotExists) Error

func (e *ErrFileNotExists) Error() string

type ErrWorkspaceNotFound

type ErrWorkspaceNotFound struct {
	CurrentDirectory      string
	ManifestDirectoryName string
	NumberOfLevelsChecked int
}

ErrWorkspaceNotFound means we couldn't locate a workspace root.

func (*ErrWorkspaceNotFound) Error

func (e *ErrWorkspaceNotFound) Error() string

type FileStat

type FileStat interface {
	Stat(name string) (os.FileInfo, error)
}

FileStat wraps the os.Stat function.

type PipelineManifest

type PipelineManifest struct {
	Name string // Name of the pipeline inside the manifest file.
	Path string // Absolute path to the manifest file for the pipeline.
}

PipelineManifest holds identifying information about a pipeline manifest file.

type Summary

type Summary struct {
	Application string `yaml:"application"` // Name of the application.

	Path string // absolute path to the summary file.
}

Summary is a description of what's associated with this workspace.

type WorkloadManifest

type WorkloadManifest []byte

WorkloadManifest represents raw local workload manifest.

func (WorkloadManifest) WorkloadType

func (w WorkloadManifest) WorkloadType() (string, error)

WorkloadType returns the workload type of the manifest.

type Workspace

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

Workspace typically represents a Git repository where the user has its infrastructure-as-code files as well as source files.

func New

func New() (*Workspace, error)

New returns a workspace, used for reading and writing to user's local workspace.

func (*Workspace) Create

func (ws *Workspace) Create(appName string) error

Create creates the copilot directory (if it doesn't already exist) in the current working directory, and saves a summary with the application name.

func (*Workspace) DeleteWorkspaceFile

func (ws *Workspace) DeleteWorkspaceFile() error

DeleteWorkspaceFile removes the .workspace file under copilot/ directory. This will be called during app delete, we do not want to delete any other generated files.

func (*Workspace) ListDockerfiles

func (ws *Workspace) ListDockerfiles() ([]string, error)

ListDockerfiles returns the list of Dockerfiles within the current working directory and a sub-directory level below. If an error occurs while reading directories, or no Dockerfiles found returns the error.

func (*Workspace) ListEnvironments

func (ws *Workspace) ListEnvironments() ([]string, error)

ListEnvironments returns the name of the environments in the workspace.

func (*Workspace) ListJobs

func (ws *Workspace) ListJobs() ([]string, error)

ListJobs returns the names of all jobs in the workspace.

func (*Workspace) ListPipelines

func (ws *Workspace) ListPipelines() ([]PipelineManifest, error)

ListPipelines returns all pipelines in the workspace.

func (*Workspace) ListServices

func (ws *Workspace) ListServices() ([]string, error)

ListServices returns the names of the services in the workspace.

func (*Workspace) ListWorkloads

func (ws *Workspace) ListWorkloads() ([]string, error)

ListWorkloads returns the name of all the workloads in the workspace (could be unregistered in SSM).

func (*Workspace) Path

func (ws *Workspace) Path() (string, error)

Path returns the absolute path to the workspace.

func (*Workspace) ReadAddon

func (ws *Workspace) ReadAddon(svc, fname string) ([]byte, error)

ReadAddon returns the contents of a file under the service's "addons/" directory.

func (*Workspace) ReadAddonsDir

func (ws *Workspace) ReadAddonsDir(svcName string) ([]string, error)

ReadAddonsDir returns a list of file names under a service's "addons/" directory.

func (*Workspace) ReadEnvironmentManifest

func (ws *Workspace) ReadEnvironmentManifest(mftDirName string) (EnvironmentManifest, error)

ReadEnvironmentManifest returns the contents of the environment's manifest under copilot/environments/{name}/manifest.yml.

func (*Workspace) ReadPipelineManifest

func (ws *Workspace) ReadPipelineManifest(path string) (*manifest.Pipeline, error)

ReadPipelineManifest returns the contents of the pipeline manifest under the given path.

func (*Workspace) ReadWorkloadManifest

func (ws *Workspace) ReadWorkloadManifest(mftDirName string) (WorkloadManifest, error)

ReadWorkloadManifest returns the contents of the workload's manifest under copilot/{name}/manifest.yml.

func (*Workspace) Rel

func (ws *Workspace) Rel(path string) (string, error)

func (*Workspace) Summary

func (ws *Workspace) Summary() (*Summary, error)

Summary returns a summary of the workspace - including the application name.

func (*Workspace) WriteAddon

func (ws *Workspace) WriteAddon(content encoding.BinaryMarshaler, svc, name string) (string, error)

WriteAddon writes the content of an addon file under "{svc}/addons/{name}.yml". If successful returns the full path of the file, otherwise an empty string and an error.

func (*Workspace) WriteEnvironmentManifest

func (ws *Workspace) WriteEnvironmentManifest(marshaler encoding.BinaryMarshaler, name string) (string, error)

WriteEnvironmentManifest writes the environment manifest under the copilot/environments/{name}/ directory. If successful returns the full path of the file, otherwise returns an empty string and the error.

func (*Workspace) WriteJobManifest

func (ws *Workspace) WriteJobManifest(marshaler encoding.BinaryMarshaler, name string) (string, error)

WriteJobManifest writes the job's manifest under the copilot/{name}/ directory.

func (*Workspace) WritePipelineBuildspec

func (ws *Workspace) WritePipelineBuildspec(marshaler encoding.BinaryMarshaler, name string) (string, error)

WritePipelineBuildspec writes the pipeline buildspec under the copilot/pipelines/{name}/ directory. If successful returns the full path of the file, otherwise returns an empty string and the error.

func (*Workspace) WritePipelineManifest

func (ws *Workspace) WritePipelineManifest(marshaler encoding.BinaryMarshaler, name string) (string, error)

WritePipelineManifest writes the pipeline manifest under the copilot/pipelines/{name}/ directory. If successful returns the full path of the file, otherwise returns an empty string and the error.

func (*Workspace) WriteServiceManifest

func (ws *Workspace) WriteServiceManifest(marshaler encoding.BinaryMarshaler, name string) (string, error)

WriteServiceManifest writes the service's manifest under the copilot/{name}/ directory.