Skip to content
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
130 changes: 130 additions & 0 deletions cmd/lesser/release_contract_examples_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,39 @@ type lambdaBundleManifestExample struct {
} `json:"files"`
}

type deployAssemblyDescriptorExample struct {
Kind string `json:"kind"`
SchemaVersion int `json:"schema_version"`
Release struct {
Name string `json:"name"`
Version string `json:"version"`
GitSHA string `json:"git_sha"`
} `json:"release"`
Assembly struct {
Path string `json:"path"`
Format string `json:"format"`
SHA256 string `json:"sha256"`
} `json:"assembly"`
Payload struct {
Kind string `json:"kind"`
ContractVersion int `json:"contract_version"`
Entrypoint string `json:"entrypoint"`
} `json:"payload"`
Compatibility struct {
ReleaseManifestPath string `json:"release_manifest_path"`
DeployArtifactsKey string `json:"deploy_artifacts_key"`
ExecutorContractValue int `json:"executor_contract_version"`
} `json:"compatibility"`
InstanceInputs struct {
Required []string `json:"required"`
Optional []string `json:"optional"`
} `json:"instance_inputs"`
Verification struct {
IntegrityRequired []string `json:"integrity_required"`
PreflightRequired []string `json:"preflight_required"`
} `json:"verification"`
}

func TestLambdaBundleManifestExampleContract(t *testing.T) {
repoRoot, err := findRepoRoot()
require.NoError(t, err)
Expand Down Expand Up @@ -112,6 +145,103 @@ func TestLambdaBundleManifestSchemaContract(t *testing.T) {
require.Equal(t, "lesser.lambda_inventory", anyMap(t, inventoryProps["kind"])["const"])
}

func TestDeployAssemblyDescriptorExampleContract(t *testing.T) {
repoRoot, err := findRepoRoot()
require.NoError(t, err)

data, err := os.ReadFile(filepath.Join(repoRoot, "docs", "contracts", "examples", "lesser-deploy-assembly.example.json"))
require.NoError(t, err)

var descriptor deployAssemblyDescriptorExample
require.NoError(t, json.Unmarshal(data, &descriptor))

require.Equal(t, "lesser.deploy_assembly_descriptor", descriptor.Kind)
require.Equal(t, 1, descriptor.SchemaVersion)
require.Equal(t, "lesser", descriptor.Release.Name)
require.Regexp(t, regexp.MustCompile(`^v[0-9].*$`), descriptor.Release.Version)
require.Regexp(t, regexp.MustCompile(`^[a-f0-9]{40}$`), descriptor.Release.GitSHA)
require.Equal(t, "lesser-deploy-assembly.tar.gz", descriptor.Assembly.Path)
require.Equal(t, "tar.gz", descriptor.Assembly.Format)
require.Regexp(t, regexp.MustCompile(`^[a-f0-9]{64}$`), descriptor.Assembly.SHA256)
require.Regexp(t, regexp.MustCompile(`^[a-z][a-z0-9_.-]*$`), descriptor.Payload.Kind)
require.GreaterOrEqual(t, descriptor.Payload.ContractVersion, 1)
require.NotEmpty(t, descriptor.Payload.Entrypoint)
require.NotContains(t, descriptor.Payload.Entrypoint, "..")
require.NotContains(t, descriptor.Payload.Entrypoint, `\`)
require.Equal(t, "lesser-release.json", descriptor.Compatibility.ReleaseManifestPath)
require.Equal(t, "deploy_assembly", descriptor.Compatibility.DeployArtifactsKey)
require.GreaterOrEqual(t, descriptor.Compatibility.ExecutorContractValue, 1)
require.ElementsMatch(t, []string{
"app_identity",
"aws_target",
"base_domain",
"feature_config",
"hosted_zone",
"stage_plan",
}, descriptor.InstanceInputs.Required)
require.ElementsMatch(t, []string{
"bootstrap_io",
"managed_service_urls",
"provisioning_input",
}, descriptor.InstanceInputs.Optional)
require.NotEmpty(t, descriptor.Verification.IntegrityRequired)
require.NotEmpty(t, descriptor.Verification.PreflightRequired)
}

func TestDeployAssemblyDescriptorSchemaContract(t *testing.T) {
repoRoot, err := findRepoRoot()
require.NoError(t, err)

data, err := os.ReadFile(filepath.Join(repoRoot, "docs", "contracts", "deploy-assembly-descriptor.schema.json"))
require.NoError(t, err)

var schema map[string]any
require.NoError(t, json.Unmarshal(data, &schema))

require.Equal(t, "https://json-schema.org/draft/2020-12/schema", schema["$schema"])
require.Equal(t, "Lesser Deploy Assembly Descriptor", schema["title"])
require.ElementsMatch(t, []string{
"kind",
"schema_version",
"release",
"assembly",
"payload",
"compatibility",
"instance_inputs",
"verification",
}, anySliceToStrings(t, schema["required"]))

properties := anyMap(t, schema["properties"])
require.Equal(t, "lesser.deploy_assembly_descriptor", anyMap(t, properties["kind"])["const"])
require.Equal(t, float64(1), anyMap(t, properties["schema_version"])["const"])

assemblyProps := anyMap(t, anyMap(t, properties["assembly"])["properties"])
require.Equal(t, "lesser-deploy-assembly.tar.gz", anyMap(t, assemblyProps["path"])["const"])
require.Equal(t, "tar.gz", anyMap(t, assemblyProps["format"])["const"])

compatibilityProps := anyMap(t, anyMap(t, properties["compatibility"])["properties"])
require.Equal(t, "lesser-release.json", anyMap(t, compatibilityProps["release_manifest_path"])["const"])
require.Equal(t, "deploy_assembly", anyMap(t, compatibilityProps["deploy_artifacts_key"])["const"])

defs := anyMap(t, schema["$defs"])
instanceInputCategory := anyMap(t, defs["instance_input_category"])
require.ElementsMatch(t, []string{
"app_identity",
"aws_target",
"base_domain",
"hosted_zone",
"stage_plan",
"feature_config",
"managed_service_urls",
"provisioning_input",
"bootstrap_io",
}, anySliceToStrings(t, instanceInputCategory["enum"]))

instanceInputProps := anyMap(t, anyMap(t, properties["instance_inputs"])["properties"])
require.Equal(t, "#/$defs/instance_input_category", anyMap(t, anyMap(t, instanceInputProps["required"])["items"])["$ref"])
require.Equal(t, "#/$defs/instance_input_category", anyMap(t, anyMap(t, instanceInputProps["optional"])["items"])["$ref"])
}

func anyMap(t *testing.T, value any) map[string]any {
t.Helper()

Expand Down
1 change: 1 addition & 0 deletions cmd/lesser/release_deploy_assets.go
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,7 @@ func validateBundleAgainstInventory(repoRoot string, bundle releaseassets.Lambda
for _, file := range bundle.Files {
manifestNames = append(manifestNames, file.Lambda)
}
slices.Sort(manifestNames)

if !slices.Equal(lambdaNames, manifestNames) {
return fmt.Errorf("lambda bundle manifest does not match canonical inventory")
Expand Down
15 changes: 15 additions & 0 deletions cmd/lesser/release_deploy_assets_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,21 @@ func TestInstallReleaseLambdaAssets_ErrorsWhenInventoryDoesNotMatch(t *testing.T
require.Contains(t, err.Error(), "does not match canonical inventory")
}

func TestInstallReleaseLambdaAssets_AcceptsPathSortedBundleManifest(t *testing.T) {
sourceRepo := testRepoWithCanonicalInventory(t, []string{"graphql", "graphql-ws"})
require.NoError(t, os.MkdirAll(filepath.Join(sourceRepo, "bin"), 0o755))
require.NoError(t, os.WriteFile(filepath.Join(sourceRepo, "bin", "graphql.zip"), []byte("graphql zip"), 0o644))
require.NoError(t, os.WriteFile(filepath.Join(sourceRepo, "bin", "graphql-ws.zip"), []byte("graphql-ws zip"), 0o644))

releaseDir := testReleaseDirFromRepo(t, sourceRepo)
targetRepo := testRepoWithCanonicalInventory(t, []string{"graphql", "graphql-ws"})

result, err := installReleaseLambdaAssets(targetRepo, releaseDir, filepath.Join(t.TempDir(), "lambda-assets"))
require.NoError(t, err)
require.Equal(t, "v1.2.3", result.Version)
require.Equal(t, "0123456789abcdef0123456789abcdef01234567", result.GitSHA)
}

func TestVerifyReleaseChecksums_MissingEntry(t *testing.T) {
releaseDir := t.TempDir()
files := releaseFileSet{
Expand Down
2 changes: 2 additions & 0 deletions docs/contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ running environment.
- Release-driven deploy contract: `docs/contracts/release-driven-deploy-contract.md`
- Lambda bundle manifest schema: `docs/contracts/lambda-bundle-manifest.schema.json`
- Lambda bundle manifest example: `docs/contracts/examples/lesser-lambda-bundle.example.json`
- Deploy assembly descriptor schema: `docs/contracts/deploy-assembly-descriptor.schema.json`
- Deploy assembly descriptor example: `docs/contracts/examples/lesser-deploy-assembly.example.json`
- Published release metadata now includes `lesser-release.json` entries that point at the Lambda bundle and manifest
for release-driven deploy consumers.

Expand Down
180 changes: 180 additions & 0 deletions docs/contracts/deploy-assembly-descriptor.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://equalto.ai/contracts/deploy-assembly-descriptor.schema.json",
"title": "Lesser Deploy Assembly Descriptor",
"type": "object",
"additionalProperties": false,
"$defs": {
"instance_input_category": {
"type": "string",
"enum": [
"app_identity",
"aws_target",
"base_domain",
"hosted_zone",
"stage_plan",
"feature_config",
"managed_service_urls",
"provisioning_input",
"bootstrap_io"
]
}
},
"required": [
"kind",
"schema_version",
"release",
"assembly",
"payload",
"compatibility",
"instance_inputs",
"verification"
],
"properties": {
"kind": {
"const": "lesser.deploy_assembly_descriptor"
},
"schema_version": {
"const": 1
},
"release": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"version",
"git_sha"
],
"properties": {
"name": {
"const": "lesser"
},
"version": {
"type": "string",
"pattern": "^v[0-9].*$"
},
"git_sha": {
"type": "string",
"pattern": "^[a-f0-9]{40}$"
}
}
},
"assembly": {
"type": "object",
"additionalProperties": false,
"required": [
"path",
"format",
"sha256"
],
"properties": {
"path": {
"const": "lesser-deploy-assembly.tar.gz"
},
"format": {
"const": "tar.gz"
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
}
},
"payload": {
"type": "object",
"additionalProperties": false,
"required": [
"kind",
"contract_version",
"entrypoint"
],
"properties": {
"kind": {
"type": "string",
"pattern": "^[a-z][a-z0-9_.-]*$"
},
"contract_version": {
"type": "integer",
"minimum": 1
},
"entrypoint": {
"type": "string",
"pattern": "^(?!/)(?!.*\\.\\.)(?!.*\\\\).+$"
}
}
},
"compatibility": {
"type": "object",
"additionalProperties": false,
"required": [
"release_manifest_path",
"deploy_artifacts_key",
"executor_contract_version"
],
"properties": {
"release_manifest_path": {
"const": "lesser-release.json"
},
"deploy_artifacts_key": {
"const": "deploy_assembly"
},
"executor_contract_version": {
"type": "integer",
"minimum": 1
}
}
},
"instance_inputs": {
"type": "object",
"additionalProperties": false,
"required": [
"required",
"optional"
],
"properties": {
"required": {
"type": "array",
"items": {
"$ref": "#/$defs/instance_input_category"
},
"uniqueItems": true
},
"optional": {
"type": "array",
"items": {
"$ref": "#/$defs/instance_input_category"
},
"uniqueItems": true
}
}
},
"verification": {
"type": "object",
"additionalProperties": false,
"required": [
"integrity_required",
"preflight_required"
],
"properties": {
"integrity_required": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z][a-z0-9_.-]*$"
},
"minItems": 1,
"uniqueItems": true
},
"preflight_required": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z][a-z0-9_.-]*$"
},
"minItems": 1,
"uniqueItems": true
}
}
}
}
}
Loading
Loading