mirror of
https://github.com/hanzoai/pack.git
synced 2026-09-30 23:43:13 +00:00
Jake RunzerandGitHub
d8f31b4589
* rename plan inputs to layers and use deploy base layer * runtime deps installed * step builders can create multiple steps * support config step deploy outputs * optimize when we merge vs copy layers * update snapshots * validate the deploy layers * fix tests * dont add mise if no packages * fix pruning for php * update layer merging and snapshot tests * dont include mise commands or variables if no packages * update docs * update snapshots and normalization * add guide for adding custom steps * support .node-version file * fix compile errors * update snapshot tests
383 lines
7.1 KiB
Go
383 lines
7.1 KiB
Go
package plan
|
|
|
|
import (
|
|
"encoding/json"
|
|
"testing"
|
|
|
|
"github.com/google/go-cmp/cmp"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestSerialization(t *testing.T) {
|
|
jsonPlan := `{
|
|
"steps": [
|
|
{
|
|
"name": "install",
|
|
"commands": [
|
|
{"cmd": "apt-get update"},
|
|
{"cmd": "apt-get install -y curl"}
|
|
],
|
|
"startingImage": "ubuntu:22.04"
|
|
},
|
|
{
|
|
"name": "deps",
|
|
"dependsOn": ["install"],
|
|
"commands": [
|
|
{"path": "/root/.npm", "name": ".npmrc"},
|
|
{"cmd": "npm ci"},
|
|
{"cmd": "npm run build"}
|
|
],
|
|
"useSecrets": true,
|
|
"outputs": [
|
|
"dist",
|
|
"node_modules/.cache"
|
|
],
|
|
"assets": {
|
|
"npmrc": "registry=https://registry.npmjs.org/\n//registry.npmjs.org/:_authToken=${NPM_TOKEN}\nalways-auth=true"
|
|
}
|
|
},
|
|
{
|
|
"name": "build",
|
|
"dependsOn": ["deps"],
|
|
"commands": [
|
|
{"src": ".", "dest": "."},
|
|
{"cmd": "npm run test"},
|
|
{"path": "/usr/local/bin"},
|
|
{"name": "NODE_ENV", "value": "production"}
|
|
],
|
|
"useSecrets": false
|
|
}
|
|
],
|
|
"start": {
|
|
"baseImage": "node:18-slim",
|
|
"cmd": "npm start",
|
|
"paths": ["/usr/local/bin", "/app/node_modules/.bin"]
|
|
},
|
|
"caches": {
|
|
"npm": {
|
|
"directory": "/root/.npm",
|
|
"type": "shared"
|
|
},
|
|
"build-cache": {
|
|
"directory": "node_modules/.cache",
|
|
"type": "locked"
|
|
}
|
|
},
|
|
"secrets": ["NPM_TOKEN", "GITHUB_TOKEN"]
|
|
}`
|
|
|
|
var plan1 BuildPlan
|
|
err := json.Unmarshal([]byte(jsonPlan), &plan1)
|
|
require.NoError(t, err)
|
|
|
|
serialized, err := json.MarshalIndent(&plan1, "", " ")
|
|
require.NoError(t, err)
|
|
|
|
var plan2 BuildPlan
|
|
err = json.Unmarshal(serialized, &plan2)
|
|
require.NoError(t, err)
|
|
|
|
if diff := cmp.Diff(plan1, plan2); diff != "" {
|
|
t.Errorf("plans mismatch (-want +got):\n%s", diff)
|
|
}
|
|
}
|
|
|
|
func TestNormalize(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
plan *BuildPlan
|
|
expectedPlan *BuildPlan
|
|
}{
|
|
{
|
|
name: "empty plan",
|
|
plan: &BuildPlan{
|
|
Steps: []Step{},
|
|
Deploy: Deploy{},
|
|
},
|
|
expectedPlan: &BuildPlan{
|
|
Steps: []Step{},
|
|
Deploy: Deploy{},
|
|
},
|
|
},
|
|
{
|
|
name: "removes empty inputs",
|
|
plan: &BuildPlan{
|
|
Steps: []Step{
|
|
{
|
|
Name: "step1",
|
|
Inputs: []Layer{
|
|
{},
|
|
NewStepLayer("step2"),
|
|
},
|
|
},
|
|
},
|
|
Deploy: Deploy{
|
|
Inputs: []Layer{
|
|
{},
|
|
NewImageLayer("ubuntu:22.04"),
|
|
},
|
|
},
|
|
},
|
|
expectedPlan: &BuildPlan{
|
|
Steps: []Step{
|
|
{
|
|
Name: "step1",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step2"),
|
|
},
|
|
},
|
|
},
|
|
Deploy: Deploy{
|
|
Inputs: []Layer{
|
|
NewImageLayer("ubuntu:22.04"),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "removes unreferenced steps",
|
|
plan: &BuildPlan{
|
|
Steps: []Step{
|
|
{
|
|
Name: "step1",
|
|
Inputs: []Layer{},
|
|
},
|
|
{
|
|
Name: "step2",
|
|
Inputs: []Layer{},
|
|
},
|
|
{
|
|
Name: "step3",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step2"),
|
|
},
|
|
},
|
|
{
|
|
Name: "step4",
|
|
Inputs: []Layer{},
|
|
},
|
|
},
|
|
Deploy: Deploy{
|
|
Base: NewStepLayer("step4"),
|
|
Inputs: []Layer{
|
|
NewStepLayer("step3"),
|
|
},
|
|
},
|
|
},
|
|
expectedPlan: &BuildPlan{
|
|
Steps: []Step{
|
|
{
|
|
Name: "step3",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step2"),
|
|
},
|
|
},
|
|
{
|
|
Name: "step2",
|
|
Inputs: []Layer{},
|
|
},
|
|
{
|
|
Name: "step4",
|
|
Inputs: []Layer{},
|
|
},
|
|
},
|
|
Deploy: Deploy{
|
|
Base: NewStepLayer("step4"),
|
|
Inputs: []Layer{
|
|
NewStepLayer("step3"),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "keeps only transitively referenced steps",
|
|
plan: &BuildPlan{
|
|
Steps: []Step{
|
|
{
|
|
Name: "step1",
|
|
Inputs: []Layer{},
|
|
},
|
|
{
|
|
Name: "step2",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step1"),
|
|
},
|
|
},
|
|
{
|
|
Name: "step3",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step2"),
|
|
},
|
|
},
|
|
{
|
|
Name: "step4",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step3"),
|
|
},
|
|
},
|
|
{
|
|
Name: "step5",
|
|
Inputs: []Layer{},
|
|
},
|
|
},
|
|
Deploy: Deploy{
|
|
Base: NewStepLayer("step3"),
|
|
Inputs: []Layer{
|
|
NewStepLayer("step5"),
|
|
},
|
|
},
|
|
},
|
|
expectedPlan: &BuildPlan{
|
|
Steps: []Step{
|
|
{
|
|
Name: "step1",
|
|
Inputs: []Layer{},
|
|
},
|
|
{
|
|
Name: "step2",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step1"),
|
|
},
|
|
},
|
|
{
|
|
Name: "step3",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step2"),
|
|
},
|
|
},
|
|
{
|
|
Name: "step5",
|
|
Inputs: []Layer{},
|
|
},
|
|
},
|
|
Deploy: Deploy{
|
|
Base: NewStepLayer("step3"),
|
|
Inputs: []Layer{
|
|
NewStepLayer("step5"),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "handles circular dependencies",
|
|
plan: &BuildPlan{
|
|
Steps: []Step{
|
|
{
|
|
Name: "step1",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step2"),
|
|
},
|
|
},
|
|
{
|
|
Name: "step2",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step3"),
|
|
},
|
|
},
|
|
{
|
|
Name: "step3",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step1"),
|
|
},
|
|
},
|
|
{
|
|
Name: "step4",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step1"),
|
|
},
|
|
},
|
|
},
|
|
Deploy: Deploy{
|
|
Base: NewStepLayer("step4"),
|
|
},
|
|
},
|
|
expectedPlan: &BuildPlan{
|
|
Steps: []Step{
|
|
{
|
|
Name: "step4",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step1"),
|
|
},
|
|
},
|
|
{
|
|
Name: "step1",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step2"),
|
|
},
|
|
},
|
|
{
|
|
Name: "step2",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step3"),
|
|
},
|
|
},
|
|
{
|
|
Name: "step3",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step1"),
|
|
},
|
|
},
|
|
},
|
|
Deploy: Deploy{
|
|
Base: NewStepLayer("step4"),
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "handles self-referential step",
|
|
plan: &BuildPlan{
|
|
Steps: []Step{
|
|
{
|
|
Name: "step1",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step1"), // References itself
|
|
},
|
|
},
|
|
},
|
|
Deploy: Deploy{
|
|
Base: NewStepLayer("step1"),
|
|
},
|
|
},
|
|
expectedPlan: &BuildPlan{
|
|
Steps: []Step{
|
|
{
|
|
Name: "step1",
|
|
Inputs: []Layer{
|
|
NewStepLayer("step1"),
|
|
},
|
|
},
|
|
},
|
|
Deploy: Deploy{
|
|
Base: NewStepLayer("step1"),
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
tc.plan.Normalize()
|
|
|
|
// Compare Steps length
|
|
require.Equal(t, len(tc.expectedPlan.Steps), len(tc.plan.Steps), "Steps length mismatch")
|
|
|
|
// Create map of expected steps by name for easier comparison
|
|
expectedSteps := make(map[string]Step)
|
|
for _, step := range tc.expectedPlan.Steps {
|
|
expectedSteps[step.Name] = step
|
|
}
|
|
|
|
// Verify each step is as expected
|
|
for _, step := range tc.plan.Steps {
|
|
expectedStep, exists := expectedSteps[step.Name]
|
|
require.True(t, exists, "Unexpected step: %s", step.Name)
|
|
require.Equal(t, expectedStep.Inputs, step.Inputs, "Inputs mismatch for step %s", step.Name)
|
|
}
|
|
|
|
// Compare Deploy inputs and base
|
|
require.Equal(t, tc.expectedPlan.Deploy.Inputs, tc.plan.Deploy.Inputs, "Deploy inputs mismatch")
|
|
require.Equal(t, tc.expectedPlan.Deploy.Base, tc.plan.Deploy.Base, "Deploy base mismatch")
|
|
})
|
|
}
|
|
}
|