Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(dockerExecute): Infer Kubernetes securityContext from dockerOptions #4557

Merged
merged 4 commits into from
Sep 18, 2023
Merged

feat(dockerExecute): Infer Kubernetes securityContext from dockerOptions #4557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
26f3c14
Allow running as different user on Kubernetes
modulo11 Jun 26, 2023
f9b7475
infer securityContext from dockerOptions
pbusko Sep 12, 2023
0c09e16
verify --user flag value
pbusko Sep 13, 2023
ac83f2a
Merge branch 'master' into custom-kubernetes-user
anilkeshav27 Sep 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 95 additions & 0 deletions test/groovy/DockerExecuteTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,101 @@ class DockerExecuteTest extends BasePiperTest {
assertTrue(bodyExecuted)
}

@Test
void testExecuteInsidePodWithCustomUserShort() throws Exception {
Map kubernetesConfig = [:]
helper.registerAllowedMethod('dockerExecuteOnKubernetes', [Map.class, Closure.class], { Map config, Closure body ->
kubernetesConfig = config
return body()
})
binding.setVariable('env', [ON_K8S: 'true'])
stepRule.step.dockerExecute(
script: nullScript,
dockerImage: 'maven:3.5-jdk-8-alpine',
dockerOptions: ["-u 0:0", "-v foo:bar"]
) {
bodyExecuted = true
}

assertTrue(loggingRule.log.contains('Executing inside a Kubernetes Pod'))
assertThat(kubernetesConfig.securityContext, is([
'runAsUser': 0,
'runAsGroup': 0
]))
assertTrue(bodyExecuted)
}

@Test
void testExecuteInsidePodWithCustomUserLong() throws Exception {
Map kubernetesConfig = [:]
helper.registerAllowedMethod('dockerExecuteOnKubernetes', [Map.class, Closure.class], { Map config, Closure body ->
kubernetesConfig = config
return body()
})
binding.setVariable('env', [ON_K8S: 'true'])
stepRule.step.dockerExecute(
script: nullScript,
dockerImage: 'maven:3.5-jdk-8-alpine',
dockerOptions: ["--user 0:0", "-v foo:bar"]
) {
bodyExecuted = true
}

assertTrue(loggingRule.log.contains('Executing inside a Kubernetes Pod'))
assertThat(kubernetesConfig.securityContext, is([
'runAsUser': 0,
'runAsGroup': 0
]))
assertTrue(bodyExecuted)
}

@Test
void testExecuteInsidePodWithCustomUserNoGroup() throws Exception {
Map kubernetesConfig = [:]
helper.registerAllowedMethod('dockerExecuteOnKubernetes', [Map.class, Closure.class], { Map config, Closure body ->
kubernetesConfig = config
return body()
})
binding.setVariable('env', [ON_K8S: 'true'])
stepRule.step.dockerExecute(
script: nullScript,
dockerImage: 'maven:3.5-jdk-8-alpine',
dockerOptions: ["-v foo:bar", "-u 0"]
) {
bodyExecuted = true
}

assertTrue(loggingRule.log.contains('Executing inside a Kubernetes Pod'))
assertThat(kubernetesConfig.securityContext, is([
'runAsUser': 0
]))
assertTrue(bodyExecuted)
}

@Test
void testExecuteInsidePodWithCustomUserGroupString() throws Exception {
Map kubernetesConfig = [:]
helper.registerAllowedMethod('dockerExecuteOnKubernetes', [Map.class, Closure.class], { Map config, Closure body ->
kubernetesConfig = config
return body()
})
binding.setVariable('env', [ON_K8S: 'true'])
stepRule.step.dockerExecute(
script: nullScript,
dockerImage: 'maven:3.5-jdk-8-alpine',
dockerOptions: ["-v foo:bar", "-u root:wheel"]
) {
bodyExecuted = true
}

assertTrue(loggingRule.log.contains('Executing inside a Kubernetes Pod'))
assertThat(kubernetesConfig.securityContext, is([
'runAsUser': 'root',
'runAsGroup': 'wheel'
]))
assertTrue(bodyExecuted)
}

@Test
void testExecuteInsideDockerContainer() throws Exception {
stepRule.step.dockerExecute(script: nullScript, dockerImage: 'maven:3.5-jdk-8-alpine') {
Expand Down
66 changes: 56 additions & 10 deletions vars/dockerExecute.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,8 @@ void call(Map parameters = [:], body) {
config.dockerEnvVars?.each { key, value ->
dockerEnvVars << "$key=$value"
}

def securityContext = securityContextFromOptions(config.dockerOptions)
if (env.POD_NAME && isContainerDefined(config)) {
container(getContainerDefined(config)) {
withEnv(dockerEnvVars) {
Expand All @@ -205,6 +207,7 @@ void call(Map parameters = [:], body) {
dockerWorkspace: config.dockerWorkspace,
stashContent: config.stashContent,
stashNoDefaultExcludes: config.stashNoDefaultExcludes,
securityContext: securityContext,
]

if (config.sidecarImage) {
Expand All @@ -217,6 +220,7 @@ void call(Map parameters = [:], body) {
sidecarEnvVars: parameters.sidecarEnvVars,
]
}

dockerExecuteOnKubernetes(dockerExecuteOnKubernetesParams) {
echo "[INFO][${STEP_NAME}] Executing inside a Kubernetes Pod"
body()
Expand Down Expand Up @@ -340,20 +344,40 @@ private getDockerOptions(Map dockerEnvVars, Map dockerVolumeBind, def dockerOpti
}

if (dockerOptions) {
if (dockerOptions instanceof CharSequence) {
dockerOptions = [dockerOptions]
}
if (dockerOptions instanceof List) {
dockerOptions.each { String option ->
options << escapeBlanks(option)
}
} else {
throw new IllegalArgumentException("Unexpected type for dockerOptions. Expected was either a list or a string. Actual type was: '${dockerOptions.getClass()}'")
}
options.addAll(dockerOptionsToList(dockerOptions))
}

return options.join(' ')
}

@NonCPS
def securityContextFromOptions(dockerOptions) {
Map securityContext = [:]

if (!dockerOptions) {
return null
}

def userOption = dockerOptionsToList(dockerOptions).find { (it.startsWith("-u ") || it.startsWith("--user ")) }
if (!userOption) {
return null
}

def userOptionParts = userOption.split(" ")
if (userOptionParts.size() != 2) {
throw new IllegalArgumentException("Unexpected --user flag value in dockerOptions '${userOption}'")
}

def userGroupIds = userOptionParts[1].split(":")

securityContext.runAsUser = userGroupIds[0].isInteger() ? userGroupIds[0].toInteger() : userGroupIds[0]

if (userGroupIds.size() == 2) {
securityContext.runAsGroup = userGroupIds[1].isInteger() ? userGroupIds[1].toInteger() : userGroupIds[1]
}

return securityContext
}

boolean isContainerDefined(config) {
Map containerMap = ContainerMap.instance.getMap()
Expand Down Expand Up @@ -383,6 +407,28 @@ boolean isKubernetes() {
return Boolean.valueOf(env.ON_K8S)
}

@NonCPS
def dockerOptionsToList(dockerOptions) {
def options = []
if (!dockerOptions) {
return options
}

if (dockerOptions instanceof CharSequence) {
dockerOptions = [dockerOptions]
}

if (dockerOptions instanceof List) {
dockerOptions.each { String option ->
options << escapeBlanks(option)
}
} else {
throw new IllegalArgumentException("Unexpected type for dockerOptions. Expected was either a list or a string. Actual type was: '${dockerOptions.getClass()}'")
}

return options
}

/*
* Escapes blanks for values in key/value pairs
* E.g. <code>description=Lorem ipsum</code> is
Expand Down