Merge branch 'release/v0.16.0' into main

Author: ppxl

CHANGELOG.md

@@ -7,6 +7,11 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [v0.16.0] - 2025-01-06
+### Added
+- [#53] Add Security field to `dogu_v2`, which can be to define security policies for the dogu.
+  - This can be used for example in the pod security context on the kubernetes platform. 
+
 ## [v0.15.0] - 2024-11-13
 ### Added
 - [#43] add a timestamp to `dogu_v1` and `dogu_v2` which represents the date and time when a dogu was created

Jenkinsfile

@@ -14,6 +14,7 @@ changelog = new Changelog(this)
 repositoryOwner = "cloudogu"
 repositoryName = "cesapp-lib"
 project = "github.com/${repositoryOwner}/${repositoryName}"
+goVersion = "1.23.4"
 
 // Configuration of branches
 productionReleaseBranch = "main"
@@ -132,7 +133,7 @@ void withBuildDependencies(Closure closure) {
         etcdImage.withRun("--network ${buildnetwork} --name ${etcdContainerName}", 'etcd --listen-client-urls http://0.0.0.0:4001 --advertise-client-urls http://0.0.0.0:4001')
                 {
                     new Docker(this)
-                            .image('golang:1.18.6')
+                            .image("golang:${goVersion}")
                             .mountJenkinsUser()
                             .inside("--network ${buildnetwork} -e ETCD=${etcdContainerName} -e SKIP_SYSLOG_TESTS=true -e SKIP_DOCKER_TESTS=true --volume ${WORKSPACE}:/go/src/${project} -w /go/src/${project}")
                                     {
@@ -146,7 +147,7 @@ void potentiallyCreateDoguDocPR() {
     def targetDoguDocDir = "target/dogu-doc"
     def coreDoguChapter = "compendium_en.md"
     def oldCoreDoguChapter = "${targetDoguDocDir}/docs/core/${coreDoguChapter}"
-    def newCoreDoguChapter = "target/${coreDoguChapter}"
+    def newCoreDoguChapter = "target/compendium_en.md"
     def doguDocRepoParts = "cloudogu/dogu-development-docs"
     def doguDocRepo = "github.com/${doguDocRepoParts}.git"
     def doguDocTargetBranch = "main"
@@ -155,7 +156,7 @@ void potentiallyCreateDoguDocPR() {
     def gomarkVersion = "v0.4.1-8"
 
     new Docker(this)
-            .image('golang:1.20') // gomarkdoc needs /go/doc/comment from go 1.19+
+            .image("golang:${goVersion}") // gomarkdoc needs /go/doc/comment from go 1.19+
             .mountJenkinsUser()
             .inside("--volume ${WORKSPACE}:/go/src/${project} -w /go/src/${project}") {
 
@@ -165,7 +166,7 @@ void potentiallyCreateDoguDocPR() {
 
                 stage('Build new dogu doc page') {
                     sh "go install github.com/cloudogu/gomarkdoc/cmd/gomarkdoc@${gomarkVersion}"
-                    sh "gomarkdoc --output ${newCoreDoguChapter} core/dogu_v2.go --include-files dogu_v2.go"
+                    sh "gomarkdoc --output ${newCoreDoguChapter} core/dogu_v2.go --include-files dogu_v2.go,dogu_v2_security.go,dogu_v2_configuration_field.go,dogu_v2_dependency.go,dogu_v2_versions.go,dogu_v2_volume.go"
                 }
 
                 def shouldCreateDoguDocsPR = false

Makefile

@@ -1,8 +1,8 @@
 # Set these to the desired values
 ARTIFACT_ID=cesapp-lib
-VERSION=0.15.0
+VERSION=0.16.0
 
-GOTAG?=1.18.6
+GOTAG?=1.23.4
 MAKEFILES_VERSION=7.4.0
 
 GO_BUILD_FLAGS?=-mod=vendor -a ./...

core/dogu_format_manager.go

@@ -1,9 +1,8 @@
 package core
 
 import (
+	"fmt"
 	"io/ioutil"
-
-	"github.com/pkg/errors"
 )
 
 const (
@@ -58,17 +57,17 @@ func (d *DoguFormatHandler) GetFormatProviders() []DoguFormatProvider {
 func ReadDoguFromFile(filePath string) (*Dogu, DoguApiVersion, error) {
 	fileContent, err := GetContentOfFile(filePath)
 	if err != nil {
-		return nil, DoguApiVersionUnknown, errors.Wrap(err, "Cannot read dogu from invalid file")
+		return nil, DoguApiVersionUnknown, fmt.Errorf("cannot read dogu from invalid file: %w", err)
 	}
 
 	return ReadDoguFromString(fileContent)
 }
 
-// ReadDogusFromFile reads all dogus from a given file and returns them along with a their dogu API version.
+// ReadDogusFromFile reads all dogus from a given file and returns them along with their dogu API version.
 func ReadDogusFromFile(filePath string) ([]*Dogu, DoguApiVersion, error) {
 	fileContent, err := GetContentOfFile(filePath)
 	if err != nil {
-		return nil, DoguApiVersionUnknown, errors.Wrap(err, "Cannot read dogus from invalid file")
+		return nil, DoguApiVersionUnknown, fmt.Errorf("cannot read dogus from invalid file: %w", err)
 	}
 
 	return ReadDogusFromString(fileContent)

core/dogu_format_manager_test.go

@@ -646,7 +646,7 @@ func Test_DoguFormatProvider_WriteDoguToString(t *testing.T) {
 	}
 	dogu := Dogu{Name: "jenkins", Version: "1.625.2", DisplayName: "Jenkins CI", Dependencies: expectedDependencies}
 	expectedRepresentationV1 := "{\"Name\":\"jenkins\",\"Version\":\"1.625.2\",\"PublishedAt\":\"0001-01-01T00:00:00Z\",\"DisplayName\":\"Jenkins CI\",\"Description\":\"\",\"Category\":\"\",\"Tags\":null,\"Logo\":\"\",\"URL\":\"\",\"Image\":\"\",\"ExposedPorts\":null,\"ExposedCommands\":null,\"Volumes\":null,\"HealthCheck\":{\"Type\":\"\",\"State\":\"\",\"Port\":0,\"Path\":\"\",\"Parameters\":null},\"HealthChecks\":null,\"ServiceAccounts\":null,\"Privileged\":false,\"Configuration\":null,\"Properties\":null,\"EnvironmentVariables\":null,\"Dependencies\":[\"cas\"],\"OptionalDependencies\":null}"
-	expectedRepresentationV2 := "{\"Name\":\"jenkins\",\"Version\":\"1.625.2\",\"PublishedAt\":\"0001-01-01T00:00:00Z\",\"DisplayName\":\"Jenkins CI\",\"Description\":\"\",\"Category\":\"\",\"Tags\":null,\"Logo\":\"\",\"URL\":\"\",\"Image\":\"\",\"ExposedPorts\":null,\"ExposedCommands\":null,\"Volumes\":null,\"HealthCheck\":{\"Type\":\"\",\"State\":\"\",\"Port\":0,\"Path\":\"\",\"Parameters\":null},\"HealthChecks\":null,\"ServiceAccounts\":null,\"Privileged\":false,\"Configuration\":null,\"Properties\":null,\"EnvironmentVariables\":null,\"Dependencies\":[{\"type\":\"dogu\",\"name\":\"cas\",\"version\":\"\"}],\"OptionalDependencies\":null}"
+	expectedRepresentationV2 := "{\"Name\":\"jenkins\",\"Version\":\"1.625.2\",\"PublishedAt\":\"0001-01-01T00:00:00Z\",\"DisplayName\":\"Jenkins CI\",\"Description\":\"\",\"Category\":\"\",\"Tags\":null,\"Logo\":\"\",\"URL\":\"\",\"Image\":\"\",\"ExposedPorts\":null,\"ExposedCommands\":null,\"Volumes\":null,\"HealthCheck\":{\"Type\":\"\",\"State\":\"\",\"Port\":0,\"Path\":\"\",\"Parameters\":null},\"HealthChecks\":null,\"ServiceAccounts\":null,\"Privileged\":false,\"Security\":{\"Capabilities\":{},\"RunAsNonRoot\":false,\"ReadOnlyRootFileSystem\":false},\"Configuration\":null,\"Properties\":null,\"EnvironmentVariables\":null,\"Dependencies\":[{\"type\":\"dogu\",\"name\":\"cas\",\"version\":\"\"}],\"OptionalDependencies\":null}"
 
 	t.Run("Convert given dogu object into the string representation", func(t *testing.T) {
 		tests := []formatTest{
@@ -682,7 +682,7 @@ func Test_DoguFormatProvider_WriteDogusToString(t *testing.T) {
 	dogu2 := Dogu{Name: "scm", Version: "2.625.2", DisplayName: "Scm Manager", Dependencies: expectedDependencies}
 	dogus := []*Dogu{&dogu1, &dogu2}
 	expectedRepresentationV1 := "[{\"Name\":\"jenkins\",\"Version\":\"1.625.2\",\"PublishedAt\":\"0001-01-01T00:00:00Z\",\"DisplayName\":\"Jenkins CI\",\"Description\":\"\",\"Category\":\"\",\"Tags\":null,\"Logo\":\"\",\"URL\":\"\",\"Image\":\"\",\"ExposedPorts\":null,\"ExposedCommands\":null,\"Volumes\":null,\"HealthCheck\":{\"Type\":\"\",\"State\":\"\",\"Port\":0,\"Path\":\"\",\"Parameters\":null},\"HealthChecks\":null,\"ServiceAccounts\":null,\"Privileged\":false,\"Configuration\":null,\"Properties\":null,\"EnvironmentVariables\":null,\"Dependencies\":[\"cas\"],\"OptionalDependencies\":null},{\"Name\":\"scm\",\"Version\":\"2.625.2\",\"PublishedAt\":\"0001-01-01T00:00:00Z\",\"DisplayName\":\"Scm Manager\",\"Description\":\"\",\"Category\":\"\",\"Tags\":null,\"Logo\":\"\",\"URL\":\"\",\"Image\":\"\",\"ExposedPorts\":null,\"ExposedCommands\":null,\"Volumes\":null,\"HealthCheck\":{\"Type\":\"\",\"State\":\"\",\"Port\":0,\"Path\":\"\",\"Parameters\":null},\"HealthChecks\":null,\"ServiceAccounts\":null,\"Privileged\":false,\"Configuration\":null,\"Properties\":null,\"EnvironmentVariables\":null,\"Dependencies\":[\"cas\"],\"OptionalDependencies\":null}]"
-	expectedRepresentationV2 := "[{\"Name\":\"jenkins\",\"Version\":\"1.625.2\",\"PublishedAt\":\"0001-01-01T00:00:00Z\",\"DisplayName\":\"Jenkins CI\",\"Description\":\"\",\"Category\":\"\",\"Tags\":null,\"Logo\":\"\",\"URL\":\"\",\"Image\":\"\",\"ExposedPorts\":null,\"ExposedCommands\":null,\"Volumes\":null,\"HealthCheck\":{\"Type\":\"\",\"State\":\"\",\"Port\":0,\"Path\":\"\",\"Parameters\":null},\"HealthChecks\":null,\"ServiceAccounts\":null,\"Privileged\":false,\"Configuration\":null,\"Properties\":null,\"EnvironmentVariables\":null,\"Dependencies\":[{\"type\":\"dogu\",\"name\":\"cas\",\"version\":\"\"}],\"OptionalDependencies\":null},{\"Name\":\"scm\",\"Version\":\"2.625.2\",\"PublishedAt\":\"0001-01-01T00:00:00Z\",\"DisplayName\":\"Scm Manager\",\"Description\":\"\",\"Category\":\"\",\"Tags\":null,\"Logo\":\"\",\"URL\":\"\",\"Image\":\"\",\"ExposedPorts\":null,\"ExposedCommands\":null,\"Volumes\":null,\"HealthCheck\":{\"Type\":\"\",\"State\":\"\",\"Port\":0,\"Path\":\"\",\"Parameters\":null},\"HealthChecks\":null,\"ServiceAccounts\":null,\"Privileged\":false,\"Configuration\":null,\"Properties\":null,\"EnvironmentVariables\":null,\"Dependencies\":[{\"type\":\"dogu\",\"name\":\"cas\",\"version\":\"\"}],\"OptionalDependencies\":null}]"
+	expectedRepresentationV2 := "[{\"Name\":\"jenkins\",\"Version\":\"1.625.2\",\"PublishedAt\":\"0001-01-01T00:00:00Z\",\"DisplayName\":\"Jenkins CI\",\"Description\":\"\",\"Category\":\"\",\"Tags\":null,\"Logo\":\"\",\"URL\":\"\",\"Image\":\"\",\"ExposedPorts\":null,\"ExposedCommands\":null,\"Volumes\":null,\"HealthCheck\":{\"Type\":\"\",\"State\":\"\",\"Port\":0,\"Path\":\"\",\"Parameters\":null},\"HealthChecks\":null,\"ServiceAccounts\":null,\"Privileged\":false,\"Security\":{\"Capabilities\":{},\"RunAsNonRoot\":false,\"ReadOnlyRootFileSystem\":false},\"Configuration\":null,\"Properties\":null,\"EnvironmentVariables\":null,\"Dependencies\":[{\"type\":\"dogu\",\"name\":\"cas\",\"version\":\"\"}],\"OptionalDependencies\":null},{\"Name\":\"scm\",\"Version\":\"2.625.2\",\"PublishedAt\":\"0001-01-01T00:00:00Z\",\"DisplayName\":\"Scm Manager\",\"Description\":\"\",\"Category\":\"\",\"Tags\":null,\"Logo\":\"\",\"URL\":\"\",\"Image\":\"\",\"ExposedPorts\":null,\"ExposedCommands\":null,\"Volumes\":null,\"HealthCheck\":{\"Type\":\"\",\"State\":\"\",\"Port\":0,\"Path\":\"\",\"Parameters\":null},\"HealthChecks\":null,\"ServiceAccounts\":null,\"Privileged\":false,\"Security\":{\"Capabilities\":{},\"RunAsNonRoot\":false,\"ReadOnlyRootFileSystem\":false},\"Configuration\":null,\"Properties\":null,\"EnvironmentVariables\":null,\"Dependencies\":[{\"type\":\"dogu\",\"name\":\"cas\",\"version\":\"\"}],\"OptionalDependencies\":null}]"
 
 	t.Run("Convert given dogu object into the string representation", func(t *testing.T) {
 		tests := []formatTest{
@@ -713,3 +713,11 @@ func Test_DoguFormatProvider_WriteDogusToString(t *testing.T) {
 		}
 	})
 }
+
+func TestUnmarshalProperties(t *testing.T) {
+	dogu := &Dogu{}
+	dogu, _, err := ReadDoguFromFile("../resources/test/unmarshalProperties.json")
+	require.Nil(t, err)
+	assert.Equal(t, "http://test.test", dogu.Properties["logoutUrl"])
+	assert.Equal(t, "25", dogu.Properties["TestPort"])
+}