chore(python, java): Extract common buildpack code

Signed-off-by: Andrew Meyer <[email protected]>

Author: menehune23

buildpacks/Makefile

@@ -9,11 +9,12 @@ buildpack.path := $(abspath $(path))
 include $(buildpack.path)/rules.mk
 
 # Include test case images
-buildpack.languages = \
+buildpack.subdirs = \
+    common \
 	python \
 	java \
 
-SUBDIRS := $(addprefix $(buildpack.path)/, $(buildpack.languages))
+SUBDIRS := $(addprefix $(buildpack.path)/, $(buildpack.subdirs))
 $(foreach dir,$(SUBDIRS),$(eval $(call INCLUDE_FILE, $(dir))))
 endif
 
@@ -28,5 +29,5 @@ all .PHONY: buildpacks
 buildpacks.clean:
 clean .PHONY: buildpacks.clean
 
-buildpacks.test:
+buildpacks.tests:
 tests .PHONY: buildpacks.clean

buildpacks/common/Makefile

@@ -0,0 +1,26 @@
+RULES.MK ?= ../../rules.mk
+include $(RULES.MK)
+
+path ?= .
+buildpacks.common.path := $(abspath $(path))
+
+include $(buildpacks.common.path)/../rules.mk
+
+#########
+# Testing
+#########
+
+buildpacks.common.tests.sources := \
+	$(buildpacks.common.path)/go.mod \
+	$(buildpacks.common.path)/go.sum \
+	$(shell find '$(buildpacks.common.path)/tests' -type f -iname '*.go') \
+	$(buildpacks.common.path)/tests \
+
+#########
+# Targets
+#########
+
+buildpacks.common.tests: $(buildpacks.common.tests.sources)
+	cd $(buildpacks.common.path) && go test -v -count=1 -timeout 30s kn-fn/buildpacks/tests
+
+buildpacks.tests .PHONY: buildpacks.common.tests

buildpacks/common/command/runner.go

@@ -0,0 +1,24 @@
+// Copyright 2021-2022 VMware, Inc.
+// SPDX-License-Identifier: BSD-2-Clause
+
+package command
+
+import (
+	"os/exec"
+)
+
+//go:generate mockgen -destination ../mock_command/runner.go . Runner
+type Runner interface {
+	Run(cmd *exec.Cmd) (output string, err error)
+}
+
+type DefaultRunner struct{}
+
+func NewDefaultRunner() *DefaultRunner {
+	return &DefaultRunner{}
+}
+
+func (dcr *DefaultRunner) Run(cmd *exec.Cmd) (output string, err error) {
+	buff, err := cmd.CombinedOutput()
+	return string(buff), err
+}

buildpacks/java/java/func_yaml.go buildpacks/common/config/func_yaml.go

@@ -1,7 +1,7 @@
 // Copyright 2021-2022 VMware, Inc.
 // SPDX-License-Identifier: BSD-2-Clause
 
-package java
+package config
 
 import (
 	"os"

buildpacks/common/go.mod

@@ -0,0 +1,43 @@
+module kn-fn/buildpacks
+
+go 1.19
+
+require (
+	github.com/paketo-buildpacks/libpak v1.61.0
+	gopkg.in/yaml.v3 v3.0.1
+	knative.dev/kn-plugin-func v0.19.0
+	knative.dev/pkg v0.0.0-20210902173607-844a6bc45596
+)
+
+require (
+	github.com/BurntSushi/toml v1.1.0 // indirect
+	github.com/Masterminds/semver/v3 v3.1.1 // indirect
+	github.com/Microsoft/go-winio v0.5.0 // indirect
+	github.com/ProtonMail/go-crypto v0.0.0-20210428141323-04723f9f07d7 // indirect
+	github.com/acomagu/bufpipe v1.0.3 // indirect
+	github.com/buildpacks/libcnb v1.26.0 // indirect
+	github.com/emirpasic/gods v1.12.0 // indirect
+	github.com/go-git/gcfg v1.5.0 // indirect
+	github.com/go-git/go-billy/v5 v5.3.1 // indirect
+	github.com/go-git/go-git/v5 v5.4.2 // indirect
+	github.com/gobuffalo/here v0.6.0 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/heroku/color v0.0.6 // indirect
+	github.com/imdario/mergo v0.3.13 // indirect
+	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
+	github.com/kevinburke/ssh_config v0.0.0-20201106050909-4977a11b4351 // indirect
+	github.com/markbates/pkger v0.17.1 // indirect
+	github.com/mattn/go-colorable v0.1.8 // indirect
+	github.com/mattn/go-isatty v0.0.12 // indirect
+	github.com/mitchellh/go-homedir v1.1.0 // indirect
+	github.com/onsi/gomega v1.19.0 // indirect
+	github.com/sergi/go-diff v1.1.0 // indirect
+	github.com/xanzy/ssh-agent v0.3.0 // indirect
+	golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a // indirect
+	golang.org/x/net v0.0.0-20220225172249-27dd8689420f // indirect
+	golang.org/x/sys v0.0.0-20220209214540-3681064d5158 // indirect
+	gopkg.in/inf.v0 v0.9.1 // indirect
+	gopkg.in/warnings.v0 v0.1.2 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+	k8s.io/apimachinery v0.20.7 // indirect
+)

buildpacks/common/go.sum

@@ -4,18 +4,19 @@
 package tests
 
 import (
-	"kn-fn/java-function-buildpack/java"
 	"testing"
 
 	"gopkg.in/yaml.v3"
 	knfn "knative.dev/kn-plugin-func"
 	"knative.dev/pkg/ptr"
+
+	"kn-fn/buildpacks/config"
 )
 
 func TestParseFuncYaml_FileDoesNotExist(t *testing.T) {
 	appDir, cleanup := SetupTestDirectory()
 	defer cleanup()
-	result := java.ParseFuncYaml(appDir, NewLogger())
+	result := config.ParseFuncYaml(appDir, NewLogger())
 	if result.Exists {
 		t.Logf("File should not exists but was detected")
 		t.Fail()
@@ -25,7 +26,7 @@ func TestParseFuncYaml_FileDoesNotExist(t *testing.T) {
 func TestParseFuncYaml_FileExistsButEmpty(t *testing.T) {
 	appDir, cleanup := SetupTestDirectory(WithFuncYaml())
 	defer cleanup()
-	result := java.ParseFuncYaml(appDir, NewLogger())
+	result := config.ParseFuncYaml(appDir, NewLogger())
 	if !result.Exists {
 		t.Logf("File should exists but was not detected")
 		t.Fail()
@@ -40,7 +41,7 @@ func TestParseFuncYaml_HasEnvs(t *testing.T) {
 
 	appDir, cleanup := SetupTestDirectory(WithFuncEnvs(envs))
 	defer cleanup()
-	result := java.ParseFuncYaml(appDir, NewLogger())
+	result := config.ParseFuncYaml(appDir, NewLogger())
 
 	for k, v := range result.Envs {
 		expected, found := envs[k]
@@ -67,7 +68,7 @@ func TestParseFuncYaml_HasScale(t *testing.T) {
 
 	appDir, cleanup := SetupTestDirectory(WithFuncScale(scaleOption))
 	defer cleanup()
-	result := java.ParseFuncYaml(appDir, NewLogger())
+	result := config.ParseFuncYaml(appDir, NewLogger())
 	resultScaleOptions := &knfn.ScaleOptions{}
 	yaml.Unmarshal([]byte(result.Options["options-scale"]), resultScaleOptions)
 
@@ -101,7 +102,7 @@ func TestParseFuncYaml_HasRequests(t *testing.T) {
 
 	appDir, cleanup := SetupTestDirectory(WithFuncResourceRequests(requestOptions))
 	defer cleanup()
-	result := java.ParseFuncYaml(appDir, NewLogger())
+	result := config.ParseFuncYaml(appDir, NewLogger())
 	resultRequestOptions := &knfn.ResourcesRequestsOptions{}
 	yaml.Unmarshal([]byte(result.Options["options-resources-requests"]), resultRequestOptions)
 
@@ -124,7 +125,7 @@ func TestParseFuncYaml_HasLimits(t *testing.T) {
 
 	appDir, cleanup := SetupTestDirectory(WithFuncResourceLimits(limitOptions))
 	defer cleanup()
-	result := java.ParseFuncYaml(appDir, NewLogger())
+	result := config.ParseFuncYaml(appDir, NewLogger())
 	resultLimitOptions := &knfn.ResourcesLimitsOptions{}
 	yaml.Unmarshal([]byte(result.Options["options-resources-limits"]), resultLimitOptions)
 

buildpacks/java/tests/func_yaml_test.go buildpacks/common/tests/func_yaml_test.go

@@ -0,0 +1,134 @@
+// Copyright 2021-2022 VMware, Inc.
+// SPDX-License-Identifier: BSD-2-Clause
+
+package tests
+
+import (
+	"bytes"
+	"fmt"
+	"io/ioutil"
+	"log"
+	"os"
+
+	"github.com/paketo-buildpacks/libpak/bard"
+	knfn "knative.dev/kn-plugin-func"
+)
+
+func NewLogger() bard.Logger {
+	buf := bytes.NewBuffer(nil)
+	return bard.NewLogger(buf)
+}
+
+type SetupOpts func(directory string)
+
+func SetupTestDirectory(opts ...SetupOpts) (string, func()) {
+	dir, err := ioutil.TempDir(os.TempDir(), "python-functions-buildpack-*")
+	if err != nil {
+		panic(fmt.Sprintf("unable to create test directory: %v", err))
+	}
+
+	for _, opt := range opts {
+		opt(dir)
+	}
+
+	cleanup := func() {
+		if err := os.RemoveAll(dir); err != nil {
+			log.Printf("Failed to delete temp directory %s: %v", dir, err)
+		}
+
+	}
+	return dir, cleanup
+}
+
+func WithFuncYaml() SetupOpts {
+	return func(directory string) {
+		cfg, err := knfn.NewFunction(directory)
+		if err != nil {
+			panic(err)
+		}
+
+		err = cfg.WriteConfig()
+		if err != nil {
+			panic(err)
+		}
+	}
+}
+
+func WithFuncEnvs(envs map[string]string) SetupOpts {
+	return func(directory string) {
+		cfg, err := knfn.NewFunction(directory)
+		if err != nil {
+			panic(err)
+		}
+
+		for envName, envValue := range envs {
+			name := envName
+			value := envValue
+			cfg.Envs = append(cfg.Envs, knfn.Env{
+				Name:  &name,
+				Value: &value,
+			})
+		}
+
+		err = cfg.WriteConfig()
+		if err != nil {
+			panic(err)
+		}
+	}
+}
+
+func WithFuncScale(scale knfn.ScaleOptions) SetupOpts {
+	return func(directory string) {
+		cfg, err := knfn.NewFunction(directory)
+		if err != nil {
+			panic(err)
+		}
+
+		cfg.Options.Scale = &scale
+
+		err = cfg.WriteConfig()
+		if err != nil {
+			panic(err)
+		}
+	}
+}
+
+func WithFuncResourceRequests(requests knfn.ResourcesRequestsOptions) SetupOpts {
+	return func(directory string) {
+		cfg, err := knfn.NewFunction(directory)
+		if err != nil {
+			panic(err)
+		}
+
+		if cfg.Options.Resources == nil {
+			cfg.Options.Resources = &knfn.ResourcesOptions{}
+		}
+
+		cfg.Options.Resources.Requests = &requests
+
+		err = cfg.WriteConfig()
+		if err != nil {
+			panic(err)
+		}
+	}
+}
+
+func WithFuncResourceLimits(limits knfn.ResourcesLimitsOptions) SetupOpts {
+	return func(directory string) {
+		cfg, err := knfn.NewFunction(directory)
+		if err != nil {
+			panic(err)
+		}
+
+		if cfg.Options.Resources == nil {
+			cfg.Options.Resources = &knfn.ResourcesOptions{}
+		}
+
+		cfg.Options.Resources.Limits = &limits
+
+		err = cfg.WriteConfig()
+		if err != nil {
+			panic(err)
+		}
+	}
+}

buildpacks/common/tests/setup.go

@@ -8,4 +8,7 @@ require (
 	gopkg.in/yaml.v3 v3.0.1
 	knative.dev/kn-plugin-func v0.19.0
 	knative.dev/pkg v0.0.0-20210902173607-844a6bc45596
+	kn-fn/buildpacks v0.0.0
 )
+
+replace kn-fn/buildpacks => ../common

buildpacks/java/go.mod

@@ -9,6 +9,8 @@ import (
 	"github.com/buildpacks/libcnb"
 	"github.com/paketo-buildpacks/libpak"
 	"github.com/paketo-buildpacks/libpak/bard"
+
+	"kn-fn/buildpacks/config"
 )
 
 type Detect struct {
@@ -26,7 +28,7 @@ func (d Detect) checkConfigs(cr libpak.ConfigurationResolver) bool {
 func (d Detect) Detect(context libcnb.DetectContext) (libcnb.DetectResult, error) {
 	result := libcnb.DetectResult{}
 
-	funcYaml := ParseFuncYaml(context.Application.Path, d.Logger)
+	funcYaml := config.ParseFuncYaml(context.Application.Path, d.Logger)
 
 	cr, err := libpak.NewConfigurationResolver(context.Buildpack, &d.Logger)
 	if err != nil {