Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(build/registry): return built oci artifact digest #64

Merged
merged 1 commit into from
Aug 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 23 additions & 15 deletions build/registry/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -109,29 +109,29 @@ func doUploadToS3(registryFilename, gitTag string) error {
return nil
}

func doPushToOCI(registryFilename, gitTag string) error {
func doPushToOCI(registryFilename, gitTag string) (*string, error) {
var ociRepoPrefix, repoGit, user, token string
var found bool

if token, found = os.LookupEnv(RegistryTokenEnv); !found {
return fmt.Errorf("environment variable with key %q not found, please set it before running this tool", RegistryTokenEnv)
return nil, fmt.Errorf("environment variable with key %q not found, please set it before running this tool", RegistryTokenEnv)
}

if user, found = os.LookupEnv(RegistryUserEnv); !found {
return fmt.Errorf("environment variable with key %q not found, please set it before running this tool", RegistryUserEnv)
return nil, fmt.Errorf("environment variable with key %q not found, please set it before running this tool", RegistryUserEnv)
}

if ociRepoPrefix, found = os.LookupEnv(OCIRepoPrefixEnv); !found {
return fmt.Errorf("environment variable with key %q not found, please set it before running this tool", OCIRepoPrefixEnv)
return nil, fmt.Errorf("environment variable with key %q not found, please set it before running this tool", OCIRepoPrefixEnv)
}

if repoGit, found = os.LookupEnv(RepoGithubEnv); !found {
return fmt.Errorf("environment variable with key %q not found, please set it before running this tool", RepoGithubEnv)
return nil, fmt.Errorf("environment variable with key %q not found, please set it before running this tool", RepoGithubEnv)
}

pt, err := parseGitTag(gitTag)
if err != nil {
return err
return nil, err
}

cred := &auth.Credential{
Expand All @@ -144,18 +144,18 @@ func doPushToOCI(registryFilename, gitTag string) error {

reg, err := loadRegistryFromFile(registryFilename)
if err != nil {
return fmt.Errorf("could not read registry from %s: %w", registryFilename, err)
return nil, fmt.Errorf("could not read registry from %s: %w", registryFilename, err)
}

rulesfileInfo := reg.RulesfileByName(pt.Name)
if rulesfileInfo == nil {
return fmt.Errorf("could not find rulesfile %s in registry", pt.Name)
return nil, fmt.Errorf("could not find rulesfile %s in registry", pt.Name)
}

// Create the repository object for the ref.
var repo *repository.Repository
if repo, err = repository.NewRepository(ociRepoRef, repository.WithClient(client)); err != nil {
return fmt.Errorf("unable to create repository for ref %q: %w", ociRepoRef, err)
return nil, fmt.Errorf("unable to create repository for ref %q: %w", ociRepoRef, err)
}

existingTags, _ := repo.Tags(context.Background())
Expand All @@ -171,19 +171,21 @@ func doPushToOCI(registryFilename, gitTag string) error {

tgzFile := filepath.Join(tmpDir, filepath.Base(rulesfileInfo.Path)+".tar.gz")
if err = tarGzSingleFile(tgzFile, rulesfileInfo.Path); err != nil {
return fmt.Errorf("could not compress %s: %w", rulesfileInfo.Path, err)
return nil, fmt.Errorf("could not compress %s: %w", rulesfileInfo.Path, err)
}
defer os.RemoveAll(tgzFile)

config, err := rulesfileConfig(rulesfileInfo.Name, pt.Version(), rulesfileInfo.Path)
if err != nil {
return fmt.Errorf("could not generate configuration layer for rulesfiles %q: %w", rulesfileInfo.Path, err)
return nil, fmt.Errorf("could not generate configuration layer for rulesfiles %q: %w", rulesfileInfo.Path, err)
}
if err = pushCompressedRulesfile(client, tgzFile, ociRepoRef, repoGit, tagsToUpdate, config); err != nil {
return fmt.Errorf("could not push %s to %s with source %s and tags %v: %w", tgzFile, ociRepoRef, repoGit, tagsToUpdate, err)

digest, err := pushCompressedRulesfile(client, tgzFile, ociRepoRef, repoGit, tagsToUpdate, config)
if err != nil {
return nil, fmt.Errorf("could not push %s to %s with source %s and tags %v: %w", tgzFile, ociRepoRef, repoGit, tagsToUpdate, err)
}

return nil
return digest, nil
}

func rulesOciRepos(registryEntries *Registry, ociRepoPrefix string) (map[string]string, error) {
Expand Down Expand Up @@ -263,7 +265,13 @@ func main() {
Args: cobra.ExactArgs(2),
DisableFlagsInUseLine: true,
RunE: func(c *cobra.Command, args []string) error {
return doPushToOCI(args[0], args[1])
digest, err := doPushToOCI(args[0], args[1])
if err != nil {
return err
}
fmt.Println(*digest)

return nil
},
}

Expand Down
14 changes: 10 additions & 4 deletions build/registry/oci.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,25 @@ import (
ocipusher "github.com/falcosecurity/falcoctl/pkg/oci/pusher"
)

func pushCompressedRulesfile(ociClient remote.Client, filePath, repoRef, repoGit string, tags []string, config *oci.ArtifactConfig) error {
// pushCompressedRulesfile publishes rulesfile as OCI artifact and returns its digest.
// It possibly returns an error.
func pushCompressedRulesfile(
ociClient remote.Client,
filePath, repoRef, repoGit string,
tags []string,
config *oci.ArtifactConfig) (*string, error) {
klog.Infof("Processing compressed rulesfile %q for repo %q and tags %s...", filePath, repoRef, tags)

pusher := ocipusher.NewPusher(ociClient, false, nil)
_, err := pusher.Push(context.Background(), oci.Rulesfile, repoRef,
artifact, err := pusher.Push(context.Background(), oci.Rulesfile, repoRef,
ocipusher.WithTags(tags...),
ocipusher.WithFilepaths([]string{filePath}),
ocipusher.WithAnnotationSource(repoGit),
ocipusher.WithArtifactConfig(*config))

if err != nil {
return fmt.Errorf("an error occurred while pushing: %w", err)
return nil, fmt.Errorf("an error occurred while pushing: %w", err)
}

return nil
return &artifact.Digest, nil
}