Add docker labels (#84)

jenkinsci · Sep 13, 2021 · bf132a0 · bf132a0
1 parent be9b106
commit bf132a0
Show file tree

Hide file tree

Showing 9 changed files with 73 additions and 2 deletions.
diff --git a/11/bullseye/Dockerfile b/11/bullseye/Dockerfile
@@ -71,3 +71,11 @@ COPY setup-sshd /usr/local/bin/setup-sshd
 EXPOSE 22
 
 ENTRYPOINT ["setup-sshd"]
+
+LABEL \
+    org.opencontainers.image.vendor="Jenkins project" \
+    org.opencontainers.image.title="Official Jenkins SSH Agent Docker image" \
+    org.opencontainers.image.description="A Jenkins agent image which allows using SSH to establish the connection" \
+    org.opencontainers.image.url="https://www.jenkins.io/" \
+    org.opencontainers.image.source="https://github.com/jenkinsci/docker-ssh-agent" \
+    org.opencontainers.image.licenses="MIT"
diff --git a/11/windows/nanoserver-ltsc2019/Dockerfile b/11/windows/nanoserver-ltsc2019/Dockerfile
@@ -100,4 +100,12 @@ COPY setup-sshd.ps1 C:/ProgramData/Jenkins/setup-sshd.ps1
 
 EXPOSE 22
 
-ENTRYPOINT ["pwsh.exe", "-NoExit", "-Command", "& C:/ProgramData/Jenkins/setup-sshd.ps1"]
+ENTRYPOINT ["pwsh.exe", "-NoExit", "-Command", "& C:/ProgramData/Jenkins/setup-sshd.ps1"]
+
+LABEL `
+    org.opencontainers.image.vendor="Jenkins project" `
+    org.opencontainers.image.title="Official Jenkins SSH Agent Docker image" `
+    org.opencontainers.image.description="A Jenkins agent image which allows using SSH to establish the connection" `
+    org.opencontainers.image.url="https://www.jenkins.io/" `
+    org.opencontainers.image.source="https://github.com/jenkinsci/docker-ssh-agent" `
+    org.opencontainers.image.licenses="MIT"
diff --git a/11/windows/windowsservercore-ltsc2019/Dockerfile b/11/windows/windowsservercore-ltsc2019/Dockerfile
@@ -79,3 +79,11 @@ COPY setup-sshd.ps1 C:/ProgramData/Jenkins/setup-sshd.ps1
 EXPOSE 22
 
 ENTRYPOINT ["powershell.exe", "-NoExit", "-Command", "& C:/ProgramData/Jenkins/setup-sshd.ps1"]
+
+LABEL `
+    org.opencontainers.image.vendor="Jenkins project" `
+    org.opencontainers.image.title="Official Jenkins SSH Agent Docker image" `
+    org.opencontainers.image.description="A Jenkins agent image which allows using SSH to establish the connection" `
+    org.opencontainers.image.url="https://www.jenkins.io/" `
+    org.opencontainers.image.source="https://github.com/jenkinsci/docker-ssh-agent" `
+    org.opencontainers.image.licenses="MIT"
diff --git a/8/alpine/Dockerfile b/8/alpine/Dockerfile
@@ -62,3 +62,11 @@ COPY setup-sshd /usr/local/bin/setup-sshd
 EXPOSE 22
 
 ENTRYPOINT ["setup-sshd"]
+
+LABEL \
+    org.opencontainers.image.vendor="Jenkins project" \
+    org.opencontainers.image.title="Official Jenkins SSH Agent Docker image" \
+    org.opencontainers.image.description="A Jenkins agent image which allows using SSH to establish the connection" \
+    org.opencontainers.image.url="https://www.jenkins.io/" \
+    org.opencontainers.image.source="https://github.com/jenkinsci/docker-ssh-agent" \
+    org.opencontainers.image.licenses="MIT"
diff --git a/8/bullseye/Dockerfile b/8/bullseye/Dockerfile
@@ -62,3 +62,11 @@ COPY setup-sshd /usr/local/bin/setup-sshd
 EXPOSE 22
 
 ENTRYPOINT ["setup-sshd"]
+
+LABEL \
+    org.opencontainers.image.vendor="Jenkins project" \
+    org.opencontainers.image.title="Official Jenkins SSH Agent Docker image" \
+    org.opencontainers.image.description="A Jenkins agent image which allows using SSH to establish the connection" \
+    org.opencontainers.image.url="https://www.jenkins.io/" \
+    org.opencontainers.image.source="https://github.com/jenkinsci/docker-ssh-agent" \
+    org.opencontainers.image.licenses="MIT"
diff --git a/8/windows/nanoserver-ltsc2019/Dockerfile b/8/windows/nanoserver-ltsc2019/Dockerfile
@@ -98,4 +98,12 @@ COPY setup-sshd.ps1 C:/ProgramData/Jenkins/setup-sshd.ps1
 
 EXPOSE 22
 
-ENTRYPOINT ["pwsh.exe", "-NoExit", "-Command", "& C:/ProgramData/Jenkins/setup-sshd.ps1"]
+ENTRYPOINT ["pwsh.exe", "-NoExit", "-Command", "& C:/ProgramData/Jenkins/setup-sshd.ps1"]
+
+LABEL `
+    org.opencontainers.image.vendor="Jenkins project" `
+    org.opencontainers.image.title="Official Jenkins SSH Agent Docker image" `
+    org.opencontainers.image.description="A Jenkins agent image which allows using SSH to establish the connection" `
+    org.opencontainers.image.url="https://www.jenkins.io/" `
+    org.opencontainers.image.source="https://github.com/jenkinsci/docker-ssh-agent" `
+    org.opencontainers.image.licenses="MIT"
diff --git a/8/windows/windowsservercore-ltsc2019/Dockerfile b/8/windows/windowsservercore-ltsc2019/Dockerfile
@@ -79,3 +79,11 @@ COPY setup-sshd.ps1 C:/ProgramData/Jenkins/setup-sshd.ps1
 EXPOSE 22
 
 ENTRYPOINT ["powershell.exe", "-NoExit", "-Command", "& C:/ProgramData/Jenkins/setup-sshd.ps1"]
+
+LABEL `
+    org.opencontainers.image.vendor="Jenkins project" `
+    org.opencontainers.image.title="Official Jenkins SSH Agent Docker image" `
+    org.opencontainers.image.description="A Jenkins agent image which allows using SSH to establish the connection" `
+    org.opencontainers.image.url="https://www.jenkins.io/" `
+    org.opencontainers.image.source="https://github.com/jenkinsci/docker-ssh-agent" `
+    org.opencontainers.image.licenses="MIT"
diff --git a/tests/sshAgent.Tests.ps1 b/tests/sshAgent.Tests.ps1
@@ -100,6 +100,12 @@ Describe "[$JDK $FLAVOR] checking image metadata" {
         $stdout | Should -Match 'C:/Users/jenkins/AppData/Local/Temp'
         $stdout | Should -Match 'C:/Users/jenkins/Work'
     }
+
+    It 'source in docker metadata' {
+        $exitCode, $stdout, $stderr = Run-Program 'docker.exe' "inspect -f `"{{index .Config.Labels \`"org.opencontainers.image.source\`"}}`" $AGENT_IMAGE"
+        $exitCode | Should -Be 0
+        $stdout.Trim() | Should -Match 'https://github.com/jenkinsci/docker-ssh-agent'
+    }
 }
 
 Describe "[${JDK} ${FLAVOR}] image has correct version of java installed and in the PATH" {

diff --git a/tests/tests.bats b/tests/tests.bats
@@ -11,6 +11,15 @@ SUT_IMAGE=$(get_sut_image)
 ARCH=${ARCH:-x86_64}
 AGENT_CONTAINER=bats-jenkins-ssh-agent
 
+@test "[${SUT_IMAGE}] test label in docker metadata" {
+  local expected_source="https://github.com/jenkinsci/docker-ssh-agent"
+
+  local actual_source
+  actual_source=$(docker inspect --format '{{ index .Config.Labels "org.opencontainers.image.source"}}' "${SUT_IMAGE}")
+
+  assert_equal "${expected_source}" "${actual_source}"
+}
+
 @test "[${SUT_IMAGE}] checking image metadata" {
   local VOLUMES_MAP
   VOLUMES_MAP="$(docker inspect -f '{{.Config.Volumes}}' "${SUT_IMAGE}")"