Skip to content

Commit cc15a7d

Browse files
committed
duplicated
1 parent fc761ce commit cc15a7d

File tree

8 files changed

+94
-13
lines changed

8 files changed

+94
-13
lines changed

cmd/func-util/main.go

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,20 +74,31 @@ func socat(ctx context.Context) error {
7474
}
7575

7676
func scaffold(ctx context.Context) error {
77-
78-
if len(os.Args) != 2 {
79-
return fmt.Errorf("expected exactly one positional argument (function project path)")
77+
if len(os.Args) != 3 {
78+
return fmt.Errorf("expected exactly two positional arguments (function project path, builder)")
8079
}
8180

8281
path := os.Args[1]
82+
builder := os.Args[2]
8383

8484
f, err := fn.NewFunction(path)
8585
if err != nil {
8686
return fmt.Errorf("cannot load func project: %w", err)
8787
}
8888

89+
// TODO: gauron99 - Set the builder from the passed argument if not already set in the function config.
90+
// This is necessary because the builder value needs to be known during scaffolding to
91+
// determine the correct build directory (.s2i/builds/last vs .func/builds/last), but it
92+
// may not be persisted to func.yaml yet. By passing it as an argument from the Tekton
93+
// pipeline, we ensure the correct builder is used even when the function config is incomplete.
94+
if f.Build.Builder == "" {
95+
f.Build.Builder = builder
96+
}
97+
98+
fmt.Printf("#### scaffold: builder='%s', runtime='%s'\n", f.Build.Builder, f.Runtime)
99+
89100
if f.Runtime != "go" && f.Runtime != "python" {
90-
// Scaffolding is for now supported/needed only for Go.
101+
// Scaffolding is for now supported/needed only for Go&Python
91102
return nil
92103
}
93104

@@ -97,13 +108,25 @@ func scaffold(ctx context.Context) error {
97108
}
98109

99110
appRoot := filepath.Join(f.Root, ".s2i", "builds", "last")
111+
if f.Build.Builder != "s2i" {
112+
// TODO: gauron99 - change this completely
113+
appRoot = filepath.Join(f.Root, ".func", "builds", "last")
114+
}
115+
fmt.Printf("appRoot is '%s'\n", appRoot)
100116
_ = os.RemoveAll(appRoot)
101117

118+
// build step now includes scaffolding for go-pack
102119
err = scaffolding.Write(appRoot, f.Root, f.Runtime, f.Invoke, embeddedRepo.FS())
103120
if err != nil {
104121
return fmt.Errorf("cannot write the scaffolding: %w", err)
105122
}
106123

124+
if f.Build.Builder != "s2i" {
125+
return nil
126+
}
127+
128+
// add s2i specific changes
129+
107130
if err := os.MkdirAll(filepath.Join(f.Root, ".s2i", "bin"), 0755); err != nil {
108131
return fmt.Errorf("unable to create .s2i bin dir. %w", err)
109132
}
@@ -121,7 +144,6 @@ func scaffold(ctx context.Context) error {
121144
if err := os.WriteFile(filepath.Join(f.Root, ".s2i", "bin", "assemble"), []byte(asm), 0755); err != nil {
122145
return fmt.Errorf("unable to write go assembler. %w", err)
123146
}
124-
125147
return nil
126148
}
127149

pkg/builders/buildpacks/builder.go

Lines changed: 50 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,14 @@ import (
2323
"knative.dev/func/pkg/builders"
2424
"knative.dev/func/pkg/docker"
2525
fn "knative.dev/func/pkg/functions"
26+
"knative.dev/func/pkg/scaffolding"
2627
)
2728

2829
// DefaultName when no WithName option is provided to NewBuilder
2930
const DefaultName = builders.Pack
3031

31-
var DefaultBaseBuilder = "ghcr.io/knative/builder-jammy-base:latest"
32-
var DefaultTinyBuilder = "ghcr.io/knative/builder-jammy-tiny:latest"
32+
var DefaultBaseBuilder = "ghcr.io/gauron99/builder-jammy-base:latest"
33+
var DefaultTinyBuilder = "ghcr.io/gauron99/builder-jammy-tiny:latest"
3334

3435
var (
3536
DefaultBuilderImages = map[string]string{
@@ -46,6 +47,7 @@ var (
4647
// Ensure that all entries in this list are terminated with a trailing "/"
4748
// See GHSA-5336-2g3f-9g3m for details
4849
trustedBuilderImagePrefixes = []string{
50+
"quay.io/dfridric/",
4951
"quay.io/boson/",
5052
"gcr.io/paketo-buildpacks/",
5153
"docker.io/paketobuildpacks/",
@@ -116,7 +118,7 @@ func WithTimestamp(v bool) Option {
116118
}
117119
}
118120

119-
var DefaultLifecycleImage = "docker.io/buildpacksio/lifecycle:553c041"
121+
var DefaultLifecycleImage = "docker.io/buildpacksio/lifecycle:3659764"
120122

121123
// Build the Function at path.
122124
func (b *Builder) Build(ctx context.Context, f fn.Function, platforms []fn.Platform) (err error) {
@@ -171,6 +173,16 @@ func (b *Builder) Build(ctx context.Context, f fn.Function, platforms []fn.Platf
171173
Volumes []string
172174
}{Network: "", Volumes: nil},
173175
}
176+
177+
// NOTE: gauron99 - this might be even created into a Client function and
178+
// ran before the client.Build() all together (in the CLI). There are gonna
179+
// be commonalitites across the builders for scaffolding with some nuances
180+
// which could be handled by each "scaffolder" - similarly to builders.
181+
// scaffold
182+
if err = scaffold(f); err != nil {
183+
return
184+
}
185+
174186
if b.withTimestamp {
175187
now := time.Now()
176188
opts.CreationTime = &now
@@ -186,6 +198,12 @@ func (b *Builder) Build(ctx context.Context, f fn.Function, platforms []fn.Platf
186198
opts.Env["BPE_DEFAULT_LISTEN_ADDRESS"] = "[::]:8080"
187199
}
188200

201+
// go specific workdir set to where main is
202+
if f.Runtime == "go" {
203+
if _, ok := opts.Env["BP_GO_WORKDIR"]; !ok {
204+
opts.Env["BP_GO_WORKDIR"] = ".func/builds/last"
205+
}
206+
}
189207
var bindings = make([]string, 0, len(f.Build.Mounts))
190208
for _, m := range f.Build.Mounts {
191209
bindings = append(bindings, fmt.Sprintf("%s:%s", m.Source, m.Destination))
@@ -312,3 +330,32 @@ type ErrRuntimeNotSupported struct {
312330
func (e ErrRuntimeNotSupported) Error() string {
313331
return fmt.Sprintf("Pack builder has no default builder image for the '%v' language runtime. Please provide one.", e.Runtime)
314332
}
333+
334+
// TODO: gauron99 - unify this with other builders; temporary for the go pack
335+
//
336+
// scaffold the project
337+
func scaffold(f fn.Function) error {
338+
// Scafffolding is currently only supported by the Go runtime
339+
// Python currently uses an injector instead of this
340+
if f.Runtime != "go" {
341+
return nil
342+
}
343+
344+
contextDir := filepath.Join(".func", "builds", "last")
345+
appRoot := filepath.Join(f.Root, contextDir)
346+
_ = os.RemoveAll(appRoot)
347+
348+
// The embedded repository contains the scaffolding code itself which glues
349+
// together the middleware and a function via main
350+
embeddedRepo, err := fn.NewRepository("", "") // default is the embedded fs
351+
if err != nil {
352+
return fmt.Errorf("unable to load the embedded scaffolding. %w", err)
353+
}
354+
355+
// Write scaffolding to .func/builds/last
356+
err = scaffolding.Write(appRoot, f.Root, f.Runtime, f.Invoke, embeddedRepo.FS())
357+
if err != nil {
358+
return fmt.Errorf("unable to build due to a scaffold error. %w", err)
359+
}
360+
return nil
361+
}

pkg/builders/buildpacks/builder_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,11 +86,11 @@ func TestBuild_BuildpacksDefault(t *testing.T) {
8686
var (
8787
i = &mockImpl{}
8888
b = NewBuilder(WithImpl(i))
89-
f = fn.Function{Runtime: "go"}
89+
f = fn.Function{Runtime: "node"}
9090
)
9191

9292
i.BuildFn = func(ctx context.Context, opts pack.BuildOptions) error {
93-
expected := defaultBuildpacks["go"]
93+
expected := defaultBuildpacks["node"]
9494
if !reflect.DeepEqual(expected, opts.Buildpacks) {
9595
t.Fatalf("expected buildpacks '%v', got '%v'", expected, opts.Buildpacks)
9696
}
@@ -141,7 +141,7 @@ func TestBuild_BuilderImageExclude(t *testing.T) {
141141
b = NewBuilder( // Func Builder logic
142142
WithName(builders.Pack), WithImpl(i))
143143
f = fn.Function{
144-
Runtime: "go",
144+
Runtime: "node",
145145
}
146146
)
147147
funcIgnoreContent := []byte(`#testing comments

pkg/pipelines/tekton/tasks.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -440,13 +440,16 @@ spec:
440440
- name: path
441441
description: Path to the function project
442442
default: ""
443+
- name: builder
444+
description: Builder to be used (pack or s2i)
445+
default: ""
443446
workspaces:
444447
- name: source
445448
description: The workspace containing the function project
446449
steps:
447450
- name: func-scaffold
448451
image: %s
449-
command: ["scaffold", "$(params.path)"]
452+
command: ["scaffold", "$(params.path)", "$(params.builder)"]
450453
`, ScaffoldImage)
451454
}
452455

pkg/pipelines/tekton/templates.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -413,6 +413,11 @@ func createAndApplyPipelineRunTemplate(f fn.Function, namespace string, labels m
413413
}
414414
}
415415

416+
// add BP_GO_WORKDIR for go-build buildpack
417+
if f.Runtime == "go" {
418+
buildEnvs = append(buildEnvs, "BP_GO_WORKDIR=.func/builds/last")
419+
}
420+
416421
s2iImageScriptsUrl := defaultS2iImageScriptsUrl
417422
if f.Runtime == "quarkus" {
418423
s2iImageScriptsUrl = quarkusS2iImageScriptsUrl

pkg/pipelines/tekton/templates_pack.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ spec:
4646
params:
4747
- name: path
4848
value: $(workspaces.source.path)/$(params.contextDir)
49+
- name: builder
50+
value: pack
4951
workspaces:
5052
- name: source
5153
workspace: source-workspace

pkg/pipelines/tekton/templates_s2i.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ spec:
5454
params:
5555
- name: path
5656
value: $(workspaces.source.path)/$(params.contextDir)
57+
- name: builder
58+
value: s2i
5759
workspaces:
5860
- name: source
5961
workspace: source-workspace

pkg/scaffolding/scaffold.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import (
3131
// fs: filesytem which contains scaffolding at '[runtime]/scaffolding'
3232
// (exclusive with 'repo')
3333
func Write(out, src, runtime, invoke string, fs filesystem.Filesystem) (err error) {
34-
34+
fmt.Println("#### scaffolding.Write")
3535
// detect the signature of the source code in the given location, presuming
3636
// a runtime and invocation hint (default "http")
3737
s, err := detectSignature(src, runtime, invoke)

0 commit comments

Comments
 (0)