cleanup

Author: CCFenner

pkg/python/bom.go

@@ -2,7 +2,6 @@ package python
 
 import (
 	"fmt"
-	"path/filepath"
 
 	"github.com/SAP/jenkins-library/pkg/log"
 )
@@ -21,23 +20,18 @@ func CreateBOM(
 ) error {
 	if exists, _ := existsFn(requirementsFile); exists {
 		if err := InstallRequirements(executeFn, virtualEnv, requirementsFile); err != nil {
-			return err
+			return fmt.Errorf("failed to install requirements.txt: %w", err)
 		}
 	} else {
 		log.Entry().Warnf("unable to find requirements.txt file at %s , continuing SBOM generation without requirements.txt", requirementsFile)
 	}
 
 	if err := InstallCycloneDX(executeFn, virtualEnv, cycloneDxVersion); err != nil {
-		return err
-	}
-
-	cycloneDxBinary := "cyclonedx-py"
-	if len(virtualEnv) > 0 {
-		cycloneDxBinary = filepath.Join(virtualEnv, "bin", cycloneDxBinary)
+		return fmt.Errorf("failed to install cyclonedx module: %w", err)
 	}
 
 	log.Entry().Debug("creating BOM")
-	if err := executeFn(cycloneDxBinary,
+	if err := executeFn(getBinary(virtualEnv, "cyclonedx-py"),
 		"env",
 		"--output-file", BOMFilename,
 		"--output-format", "XML",

pkg/python/build.go

@@ -2,7 +2,6 @@ package python
 
 import (
 	"fmt"
-	"path/filepath"
 
 	"github.com/SAP/jenkins-library/pkg/log"
 )
@@ -18,19 +17,14 @@ func BuildWithSetupPy(
 		return fmt.Errorf("failed to install wheel module: %w", err)
 	}
 
-	pythonBinary := "python"
-	if len(virtualEnv) > 0 {
-		pythonBinary = filepath.Join(virtualEnv, "bin", pythonBinary)
-	}
-
 	var flags []string
 	flags = append(flags, pythonArgs...)
 	flags = append(flags, "setup.py")
 	flags = append(flags, setupArgs...)
 	flags = append(flags, "sdist", "bdist_wheel")
 
 	log.Entry().Debug("building project")
-	return executeFn(pythonBinary, flags...)
+	return executeFn(getBinary(virtualEnv, "python"), flags...)
 }
 
 func BuildWithPyProjectToml(
@@ -53,16 +47,11 @@ func BuildWithPyProjectToml(
 		return fmt.Errorf("failed to install wheel module: %w", err)
 	}
 
-	pythonBinary := "python"
-	if len(virtualEnv) > 0 {
-		pythonBinary = filepath.Join(virtualEnv, "bin", pythonBinary)
-	}
-
 	var flags []string
 	flags = append(flags, pythonArgs...)
 	flags = append(flags, "-m", "build", "--no-isolation")
 	flags = append(flags, moduleArgs...)
 
 	log.Entry().Debug("building project")
-	return executeFn(pythonBinary, flags...)
+	return executeFn(getBinary(virtualEnv, "python"), flags...)
 }

pkg/python/env.go

@@ -7,6 +7,13 @@ import (
 	"github.com/SAP/jenkins-library/pkg/log"
 )
 
+func getBinary(virtualEnv string, binary string) string {
+	if len(virtualEnv) > 0 {
+		return filepath.Join(virtualEnv, "bin", binary)
+	}
+	return binary
+}
+
 func CreateVirtualEnvironment(
 	executeFn func(executable string, params ...string) error,
 	removeFn func(executable string) error,

pkg/python/pip.go

@@ -11,18 +11,13 @@ var (
 	PipInstallFlags = []string{"install", "--upgrade", "--root-user-action=ignore"}
 )
 
-func Install(
+func install(
 	executeFn func(executable string, params ...string) error,
 	virtualEnv string,
 	module string,
 	version string,
 	extraArgs []string,
 ) error {
-	pipBinary := "pip"
-	if len(virtualEnv) > 0 {
-		pipBinary = filepath.Join(virtualEnv, "bin", pipBinary)
-	}
-
 	flags := PipInstallFlags
 	if len(extraArgs) > 0 {
 		flags = append(flags, extraArgs...)
@@ -34,26 +29,23 @@ func Install(
 		flags = append(flags, module)
 	}
 
-	if err := executeFn(pipBinary, flags...); err != nil {
-		return fmt.Errorf("failed to install %s: %w", module, err)
-	}
-	return nil
+	return executeFn(getBinary(virtualEnv, "pip"), flags...)
 }
 
 func InstallPip(
 	executeFn func(executable string, params ...string) error,
 	virtualEnv string,
 ) error {
 	log.Entry().Debug("updating pip")
-	return Install(executeFn, virtualEnv, "pip", "", nil)
+	return install(executeFn, virtualEnv, "pip", "", nil)
 }
 
 func InstallProjectDependencies(
 	executeFn func(executable string, params ...string) error,
 	virtualEnv string,
 ) error {
 	log.Entry().Debug("installing project dependencies")
-	return Install(executeFn, virtualEnv, ".", "", nil)
+	return install(executeFn, virtualEnv, ".", "", nil)
 }
 
 func InstallRequirements(
@@ -62,31 +54,31 @@ func InstallRequirements(
 	requirementsFile string,
 ) error {
 	log.Entry().Debug("installing requirements")
-	return Install(executeFn, virtualEnv, "", "", []string{"--requirement", requirementsFile})
+	return install(executeFn, virtualEnv, "", "", []string{"--requirement", requirementsFile})
 }
 
 func InstallBuild(
 	executeFn func(executable string, params ...string) error,
 	virtualEnv string,
 ) error {
 	log.Entry().Debug("installing build")
-	return Install(executeFn, virtualEnv, "build", "", nil)
+	return install(executeFn, virtualEnv, "build", "", nil)
 }
 
 func InstallWheel(
 	executeFn func(executable string, params ...string) error,
 	virtualEnv string,
 ) error {
 	log.Entry().Debug("installing wheel")
-	return Install(executeFn, virtualEnv, "wheel", "", nil)
+	return install(executeFn, virtualEnv, "wheel", "", nil)
 }
 
 func InstallTwine(
 	executeFn func(executable string, params ...string) error,
 	virtualEnv string,
 ) error {
 	log.Entry().Debug("installing twine")
-	return Install(executeFn, virtualEnv, "twine", "", nil)
+	return install(executeFn, virtualEnv, "twine", "", nil)
 }
 
 func InstallCycloneDX(
@@ -95,5 +87,5 @@ func InstallCycloneDX(
 	cycloneDXVersion string,
 ) error {
 	log.Entry().Debug("installing cyclonedx-bom")
-	return Install(executeFn, virtualEnv, "cyclonedx-bom", cycloneDXVersion, nil)
+	return install(executeFn, virtualEnv, "cyclonedx-bom", cycloneDXVersion, nil)
 }

pkg/python/publish.go

@@ -1,8 +1,6 @@
 package python
 
-import (
-	"path/filepath"
-)
+import "fmt"
 
 func PublishPackage(
 	executeFn func(executable string, params ...string) error,
@@ -13,16 +11,11 @@ func PublishPackage(
 ) error {
 	// install dependency
 	if err := InstallTwine(executeFn, virtualEnv); err != nil {
-		return err
-	}
-	// handle virtual environment
-	twineBinary := "twine"
-	if len(virtualEnv) > 0 {
-		twineBinary = filepath.Join(virtualEnv, "bin", twineBinary)
+		return fmt.Errorf("failed to install twine module: %w", err)
 	}
 	// publish project
 	return executeFn(
-		twineBinary,
+		getBinary(virtualEnv, "twine"),
 		"upload",
 		"--username", username,
 		"--password", password,