Skip to content

chore(composer): Standardize test style and increase coverage #1883

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.

Sign up for GitHub

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

Merged
rmvangun merged 8 commits into from
Nov 15, 2025
+9,373 −3,659
Merged

chore(composer): Standardize test style and increase coverage #1883

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5309eef
Increase coverage of composer
rmvangun Nov 15, 2025
d23a54e
refactor artifacts tests
rmvangun Nov 15, 2025
bd5f7dc
Improve composer/terraform coverage
rmvangun Nov 15, 2025
8732866
autofmt
rmvangun Nov 15, 2025
2f671f6
Standardize composer/blueprint tests
rmvangun Nov 15, 2025
b1f2c09
Fix for Windows
rmvangun Nov 15, 2025
0788124
Windows path fix
rmvangun Nov 15, 2025
3591185
Fix windows tests
rmvangun Nov 15, 2025
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
229 changes: 109 additions & 120 deletions pkg/composer/artifact/artifact.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,19 @@ import (
// step in the bundling pipeline, creating self-contained artifacts that include all bundled
// dependencies and metadata for distribution.

// =============================================================================
// Interfaces
// =============================================================================

// Artifact defines the interface for artifact creation operations
type Artifact interface {
Bundle() error
Write(outputPath string, tag string) (string, error)
Push(registryBase string, repoName string, tag string) error
Pull(ociRefs []string) (map[string][]byte, error)
GetTemplateData(ociRef string) (map[string][]byte, error)
}

// =============================================================================
// Types
// =============================================================================
Expand Down Expand Up @@ -64,12 +77,9 @@ type BuilderInfo struct {

// OCIArtifactInfo contains information about the OCI artifact source for blueprint data
type OCIArtifactInfo struct {
// Name is the name of the OCI artifact
Name string
// URL is the full OCI URL of the artifact
URL string
// Tag is the tag/version of the OCI artifact
Tag string
URL string
Tag string
}

// BlueprintMetadataInput represents the input metadata from contexts/_template/metadata.yaml
Expand All @@ -84,23 +94,6 @@ type BlueprintMetadataInput struct {
CliVersion string `yaml:"cliVersion,omitempty"`
}

// =============================================================================
// Interfaces
// =============================================================================

// Artifact defines the interface for artifact creation operations
type Artifact interface {
Bundle() error
Write(outputPath string, tag string) (string, error)
Push(registryBase string, repoName string, tag string) error
Pull(ociRefs []string) (map[string][]byte, error)
GetTemplateData(ociRef string) (map[string][]byte, error)
}

// =============================================================================
// ArtifactBuilder Implementation
// =============================================================================

// FileInfo holds file content and permission information
type FileInfo struct {
Content []byte
Expand Down Expand Up @@ -536,6 +529,100 @@ func ParseOCIReference(ociRef string) (*OCIArtifactInfo, error) {
}, nil
}

// ParseRegistryURL parses a registry URL string into its components.
// It handles formats like "registry.com/repo:tag", "registry.com/repo", or "oci://registry.com/repo:tag".
// Returns registryBase, repoName, tag, and an error if parsing fails.
func ParseRegistryURL(registryURL string) (registryBase, repoName, tag string, err error) {
arg := strings.TrimPrefix(registryURL, "oci://")

if lastColon := strings.LastIndex(arg, ":"); lastColon > 0 && lastColon < len(arg)-1 {
tag = arg[lastColon+1:]
arg = arg[:lastColon]
}

if firstSlash := strings.Index(arg, "/"); firstSlash >= 0 {
registryBase = arg[:firstSlash]
repoName = arg[firstSlash+1:]
} else {
return "", "", "", fmt.Errorf("invalid registry format: must include repository path (e.g., registry.com/namespace/repo)")
}

return registryBase, repoName, tag, nil
}

// IsAuthenticationError checks if the error is related to authentication failure.
// It examines common authentication error patterns in error messages to determine
// if the failure is due to authentication issues rather than other problems.
func IsAuthenticationError(err error) bool {
if err == nil {
return false
}

errStr := err.Error()

authErrorPatterns := []string{
"UNAUTHORIZED",
"unauthorized",
"authentication required",
"authentication failed",
"not authorized",
"access denied",
"login required",
"credentials required",
"401",
"403",
"unauthenticated",
"User cannot be authenticated",
"failed to push artifact",
"POST https://",
"blobs/uploads",
}

for _, pattern := range authErrorPatterns {
if strings.Contains(errStr, pattern) {
return true
}
}

return false
}

// ValidateCliVersion validates that the provided CLI version satisfies the cliVersion constraint
// specified in the template metadata. If constraint is empty, validation is skipped.
// If cliVersion is empty, validation is skipped (caller cannot determine version).
// If the CLI version is "dev" or "main" or "latest", validation is skipped as these are development builds.
// Returns an error if the constraint is specified and the version does not satisfy it.
func ValidateCliVersion(cliVersion, constraint string) error {
if constraint == "" {
return nil
}

if cliVersion == "" {
return nil
}

if cliVersion == "dev" || cliVersion == "main" || cliVersion == "latest" {
return nil
}

versionStr := strings.TrimPrefix(cliVersion, "v")
version, err := semver.NewVersion(versionStr)
if err != nil {
return fmt.Errorf("invalid CLI version format '%s': %w", cliVersion, err)
}

c, err := semver.NewConstraint(constraint)
if err != nil {
return fmt.Errorf("invalid cliVersion constraint '%s': %w", constraint, err)
}

if !c.Check(version) {
return fmt.Errorf("CLI version %s does not satisfy required constraint '%s'", cliVersion, constraint)
}

return nil
}

// =============================================================================
// Private Methods
// =============================================================================
Expand Down Expand Up @@ -1073,103 +1160,5 @@ func (a *ArtifactBuilder) downloadOCIArtifact(registry, repository, tag string)
return data, nil
}

// =============================================================================
// Helper Functions
// =============================================================================

// ParseRegistryURL parses a registry URL string into its components.
// It handles formats like "registry.com/repo:tag", "registry.com/repo", or "oci://registry.com/repo:tag".
// Returns registryBase, repoName, tag, and an error if parsing fails.
func ParseRegistryURL(registryURL string) (registryBase, repoName, tag string, err error) {
arg := strings.TrimPrefix(registryURL, "oci://")

if lastColon := strings.LastIndex(arg, ":"); lastColon > 0 && lastColon < len(arg)-1 {
tag = arg[lastColon+1:]
arg = arg[:lastColon]
}

if firstSlash := strings.Index(arg, "/"); firstSlash >= 0 {
registryBase = arg[:firstSlash]
repoName = arg[firstSlash+1:]
} else {
return "", "", "", fmt.Errorf("invalid registry format: must include repository path (e.g., registry.com/namespace/repo)")
}

return registryBase, repoName, tag, nil
}

// IsAuthenticationError checks if the error is related to authentication failure.
// It examines common authentication error patterns in error messages to determine
// if the failure is due to authentication issues rather than other problems.
func IsAuthenticationError(err error) bool {
if err == nil {
return false
}

errStr := err.Error()

authErrorPatterns := []string{
"UNAUTHORIZED",
"unauthorized",
"authentication required",
"authentication failed",
"not authorized",
"access denied",
"login required",
"credentials required",
"401",
"403",
"unauthenticated",
"User cannot be authenticated",
"failed to push artifact",
"POST https://",
"blobs/uploads",
}

for _, pattern := range authErrorPatterns {
if strings.Contains(errStr, pattern) {
return true
}
}

return false
}

// ValidateCliVersion validates that the provided CLI version satisfies the cliVersion constraint
// specified in the template metadata. If constraint is empty, validation is skipped.
// If cliVersion is empty, validation is skipped (caller cannot determine version).
// If the CLI version is "dev" or "main" or "latest", validation is skipped as these are development builds.
// Returns an error if the constraint is specified and the version does not satisfy it.
func ValidateCliVersion(cliVersion, constraint string) error {
if constraint == "" {
return nil
}

if cliVersion == "" {
return nil
}

if cliVersion == "dev" || cliVersion == "main" || cliVersion == "latest" {
return nil
}

versionStr := strings.TrimPrefix(cliVersion, "v")
version, err := semver.NewVersion(versionStr)
if err != nil {
return fmt.Errorf("invalid CLI version format '%s': %w", cliVersion, err)
}

c, err := semver.NewConstraint(constraint)
if err != nil {
return fmt.Errorf("invalid cliVersion constraint '%s': %w", constraint, err)
}

if !c.Check(version) {
return fmt.Errorf("CLI version %s does not satisfy required constraint '%s'", cliVersion, constraint)
}

return nil
}

// Ensure ArtifactBuilder implements Artifact interface
var _ Artifact = (*ArtifactBuilder)(nil)
Loading
Loading