feat: HOME variable set when running as nonroot (#20)

homecentr · May 27, 2020 · e16d138 · e16d138
1 parent edb8f96
commit e16d138
Show file tree

Hide file tree

Showing 15 changed files with 103 additions and 57 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -3,4 +3,5 @@
 **/run eol=lf
 */services.d/* eol=lf
 **/run eol=lf
-**/runas eol=lf
+**/runas eol=lf
+**/loop eol=lf
diff --git a/alpine/example/loop b/alpine/example/loop
@@ -1,6 +1,7 @@
 #!/usr/bin/with-contenv ash
 
 echo "TEST_VAR=$TEST_VAR"
+echo "HOME=$HOME"
 
 while :
 do

diff --git a/alpine/fs/etc/cont-init.d/10-init.sh b/alpine/fs/etc/cont-init.d/10-init.sh
@@ -50,6 +50,7 @@ if [ "$PUID" -ne "0" ]
 then
  adduser -u $PUID -G nonroot -D nonroot
  DISPLAY_USER="nonroot"
+ echo "/home/nonroot" > /var/run/s6/container_environment/HOME
 fi
 
 echo '

diff --git a/centos/example/loop b/centos/example/loop
@@ -1,6 +1,7 @@
 #!/usr/bin/with-contenv bash
 
 echo "TEST_VAR=$TEST_VAR"
+echo "HOME=$HOME"
 
 while :
 do

diff --git a/centos/fs/etc/cont-init.d/10-init.sh b/centos/fs/etc/cont-init.d/10-init.sh
@@ -53,6 +53,8 @@ if [ "$PUID" != "0" ]
 then
  useradd -u $PUID -g $PGID nonroot
  DISPLAY_USER="nonroot"
+
+ echo "/home/nonroot" > /var/run/s6/container_environment/HOME
 fi
 
 echo '

diff --git a/tests/build.gradle b/tests/build.gradle
@@ -17,7 +17,7 @@ repositories {
 dependencies {
  testImplementation group: 'junit', name: 'junit', version: '4.13'
  testImplementation "org.testcontainers:testcontainers:1.14.1"
- testImplementation 'io.homecentr:testcontainers-extensions:1.2.2'
+ testImplementation 'io.homecentr:testcontainers-extensions:1.3.1'
  testImplementation group: 'org.slf4j', name: 'slf4j-api', version: '1.7.30'
  testImplementation group: 'org.slf4j', name: 'slf4j-simple', version: '1.7.30'
 }

diff --git a/tests/src/test/java/BaseRestartedAsNonRootShould.java b/tests/src/test/java/BaseRestartedAsNonRootShould.java
@@ -1,8 +1,11 @@
+import helpers.BaseDockerImageTagResolver;
+import helpers.Image;
 import io.homecentr.testcontainers.containers.GenericContainerEx;
 import io.homecentr.testcontainers.containers.wait.strategy.WaitEx;
-import io.homecentr.testcontainers.images.EnvironmentImageTagResolver;
 import io.homecentr.testcontainers.images.PullPolicyEx;
-import org.junit.*;
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.testcontainers.containers.output.Slf4jLogConsumer;
@@ -11,7 +14,7 @@
 import java.time.Duration;
 
 import static io.homecentr.testcontainers.WaitLoop.waitFor;
-import static org.junit.Assert.*;
+import static org.junit.Assert.assertFalse;
 
 public class BaseRestartedAsNonRootShould {
  private static final Logger logger = LoggerFactory.getLogger(BaseRunningAsRootShould.class);
@@ -20,11 +23,11 @@ public class BaseRestartedAsNonRootShould {
 
  @BeforeClass
  public static void before() {
- _container = new GenericContainerEx<>(new EnvironmentImageTagResolver(Helpers.getDockerImageFallback()))
+ _container = new GenericContainerEx<>(new BaseDockerImageTagResolver())
  .withEnv("PUID", "7000")
  .withEnv("PGID", "8000")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
  .withImagePullPolicy(PullPolicyEx.never())
  .waitingFor(WaitEx.forS6OverlayStart());
 

diff --git a/tests/src/test/java/BaseRunningAsDefaultShould.java b/tests/src/test/java/BaseRunningAsDefaultShould.java
@@ -1,6 +1,7 @@
+import helpers.BaseDockerImageTagResolver;
+import helpers.Image;
 import io.homecentr.testcontainers.containers.GenericContainerEx;
 import io.homecentr.testcontainers.containers.wait.strategy.WaitEx;
-import io.homecentr.testcontainers.images.EnvironmentImageTagResolver;
 import io.homecentr.testcontainers.images.PullPolicyEx;
 import org.junit.AfterClass;
 import org.junit.BeforeClass;
@@ -22,9 +23,9 @@ public class BaseRunningAsDefaultShould {
 
  @BeforeClass
  public static void before() {
- _container = new GenericContainerEx<>(new EnvironmentImageTagResolver(Helpers.getDockerImageFallback()))
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
+ _container = new GenericContainerEx<>(new BaseDockerImageTagResolver())
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
  .withImagePullPolicy(PullPolicyEx.never())
  .waitingFor(WaitEx.forS6OverlayStart());
 
@@ -53,15 +54,25 @@ public void writePuidIntoOutput() throws Exception {
 
  @Test
  public void runServiceAsDefaultUid() throws Exception {
- int uid = _container.getProcessUid(Helpers.getShell() + " /usr/sbin/loop");
+ int uid = _container.getProcessUid(Image.getShell() + " /usr/sbin/loop");
 
  assertEquals(7077, uid);
  }
 
  @Test
  public void runServiceAsDefaultGid() throws Exception {
- int gid = _container.getProcessGid(Helpers.getShell() + " /usr/sbin/loop");
+ int gid = _container.getProcessGid(Image.getShell() + " /usr/sbin/loop");
 
  assertEquals(7077, gid);
  }
+
+ @Test
+ public void updateHomeEnvironmentVariable() throws Exception {
+ waitFor(Duration.ofSeconds(10), () -> _container.getLogsAnalyzer().contains("HOME=/home/nonroot"));
+ }
+
+ @Test
+ public void createHomeDirectory() throws Exception {
+ waitFor(Duration.ofSeconds(10), () -> _container.execInContainer("ls", "/home/nonroot").getExitCode() == 0);
+ }
 }
diff --git a/tests/src/test/java/BaseRunningAsNonRootShould.java b/tests/src/test/java/BaseRunningAsNonRootShould.java
@@ -1,6 +1,7 @@
+import helpers.BaseDockerImageTagResolver;
+import helpers.Image;
 import io.homecentr.testcontainers.containers.GenericContainerEx;
 import io.homecentr.testcontainers.containers.wait.strategy.WaitEx;
-import io.homecentr.testcontainers.images.EnvironmentImageTagResolver;
 import io.homecentr.testcontainers.images.PullPolicyEx;
 import org.junit.AfterClass;
 import org.junit.BeforeClass;
@@ -22,11 +23,11 @@ public class BaseRunningAsNonRootShould {
 
  @BeforeClass
  public static void before() {
- _container = new GenericContainerEx<>(new EnvironmentImageTagResolver(Helpers.getDockerImageFallback()))
+ _container = new GenericContainerEx<>(new BaseDockerImageTagResolver())
  .withEnv("PUID", "7000")
  .withEnv("PGID", "8000")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
  .withImagePullPolicy(PullPolicyEx.never())
  .waitingFor(WaitEx.forS6OverlayStart());
 
@@ -55,15 +56,25 @@ public void writePuidIntoOutput() throws Exception {
 
  @Test
  public void runServiceAsPassedUid() throws Exception {
- int uid = _container.getProcessUid(Helpers.getShell() + " /usr/sbin/loop");
+ int uid = _container.getProcessUid(Image.getShell() + " /usr/sbin/loop");
 
  assertEquals(7000, uid);
  }
 
  @Test
  public void runServiceAsPassedGid() throws Exception {
- int gid = _container.getProcessGid(Helpers.getShell() + " /usr/sbin/loop");
+ int gid = _container.getProcessGid(Image.getShell() + " /usr/sbin/loop");
 
  assertEquals(8000, gid);
  }
+
+ @Test
+ public void updateHomeEnvironmentVariable() throws Exception {
+ waitFor(Duration.ofSeconds(10), () -> _container.getLogsAnalyzer().contains("HOME=/home/nonroot"));
+ }
+
+ @Test
+ public void createHomeDirectory() throws Exception {
+ waitFor(Duration.ofSeconds(10), () -> _container.execInContainer("ls", "/home/nonroot").getExitCode() == 0);
+ }
 }
diff --git a/tests/src/test/java/BaseRunningAsRootShould.java b/tests/src/test/java/BaseRunningAsRootShould.java
@@ -1,6 +1,7 @@
+import helpers.BaseDockerImageTagResolver;
+import helpers.Image;
 import io.homecentr.testcontainers.containers.GenericContainerEx;
 import io.homecentr.testcontainers.containers.wait.strategy.WaitEx;
-import io.homecentr.testcontainers.images.EnvironmentImageTagResolver;
 import io.homecentr.testcontainers.images.PullPolicyEx;
 import org.junit.AfterClass;
 import org.junit.BeforeClass;
@@ -22,11 +23,11 @@ public class BaseRunningAsRootShould {
 
  @BeforeClass
  public static void before() {
- _container = new GenericContainerEx<>(new EnvironmentImageTagResolver(Helpers.getDockerImageFallback()))
+ _container = new GenericContainerEx<>(new BaseDockerImageTagResolver())
  .withEnv("PUID", "0")
  .withEnv("PGID", "0")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
  .withImagePullPolicy(PullPolicyEx.never())
  .waitingFor(WaitEx.forS6OverlayStart());
 
@@ -55,15 +56,20 @@ public void writeZeroPuidIntoOutput() throws Exception {
 
  @Test
  public void runServiceAsRootUid() throws Exception {
- int uid = _container.getProcessUid(Helpers.getShell() + " /usr/sbin/loop");
+ int uid = _container.getProcessUid(Image.getShell() + " /usr/sbin/loop");
 
  assertEquals(0, uid);
  }
 
  @Test
  public void runServiceAsRootGid() throws Exception {
- int gid = _container.getProcessGid(Helpers.getShell() + " /usr/sbin/loop");
+ int gid = _container.getProcessGid(Image.getShell() + " /usr/sbin/loop");
 
  assertEquals(0, gid);
  }
+
+ @Test
+ public void updateHomeEnvironmentVariable() throws Exception {
+ waitFor(Duration.ofSeconds(10), () -> _container.getLogsAnalyzer().contains("HOME=/root"));
+ }
 }
diff --git a/tests/src/test/java/BaseRunningWithEmptyPgidShould.java b/tests/src/test/java/BaseRunningWithEmptyPgidShould.java
@@ -1,6 +1,7 @@
+import helpers.BaseDockerImageTagResolver;
+import helpers.Image;
 import io.homecentr.testcontainers.containers.GenericContainerEx;
 import io.homecentr.testcontainers.containers.wait.strategy.WaitEx;
-import io.homecentr.testcontainers.images.EnvironmentImageTagResolver;
 import io.homecentr.testcontainers.images.PullPolicyEx;
 import org.junit.BeforeClass;
 import org.junit.Test;
@@ -22,11 +23,11 @@ public class BaseRunningWithEmptyPgidShould {
 
  @BeforeClass
  public static void before() {
- _container = new GenericContainerEx<>(new EnvironmentImageTagResolver(Helpers.getDockerImageFallback()))
+ _container = new GenericContainerEx<>(new BaseDockerImageTagResolver())
  .withStartupAttempts(1)
  .withEnv("PGID", "")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
  .withImagePullPolicy(PullPolicyEx.never())
  .waitingFor(WaitEx.forS6OverlayStart());
 

diff --git a/tests/src/test/java/BaseRunningWithEmptyPuidShould.java b/tests/src/test/java/BaseRunningWithEmptyPuidShould.java
@@ -1,8 +1,8 @@
+import helpers.BaseDockerImageTagResolver;
+import helpers.Image;
 import io.homecentr.testcontainers.containers.GenericContainerEx;
 import io.homecentr.testcontainers.containers.wait.strategy.WaitEx;
-import io.homecentr.testcontainers.images.EnvironmentImageTagResolver;
 import io.homecentr.testcontainers.images.PullPolicyEx;
-import org.junit.AfterClass;
 import org.junit.BeforeClass;
 import org.junit.Test;
 import org.slf4j.Logger;
@@ -15,7 +15,6 @@
 import java.time.Duration;
 
 import static io.homecentr.testcontainers.WaitLoop.waitFor;
-import static org.junit.Assert.*;
 
 public class BaseRunningWithEmptyPuidShould {
  private static final Logger logger = LoggerFactory.getLogger(BaseRunningAsRootShould.class);
@@ -24,11 +23,11 @@ public class BaseRunningWithEmptyPuidShould {
 
  @BeforeClass
  public static void before() {
- _container = new GenericContainerEx<>(new EnvironmentImageTagResolver(Helpers.getDockerImageFallback()))
+ _container = new GenericContainerEx<>(new BaseDockerImageTagResolver())
  .withStartupAttempts(1)
  .withEnv("PUID", "")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
  .withImagePullPolicy(PullPolicyEx.never())
  .waitingFor(WaitEx.forS6OverlayStart());
 

diff --git a/tests/src/test/java/BaseWithSecretFileVariableShould.java b/tests/src/test/java/BaseWithSecretFileVariableShould.java
@@ -1,6 +1,7 @@
+import helpers.BaseDockerImageTagResolver;
+import helpers.Image;
 import io.homecentr.testcontainers.containers.GenericContainerEx;
 import io.homecentr.testcontainers.containers.wait.strategy.WaitEx;
-import io.homecentr.testcontainers.images.EnvironmentImageTagResolver;
 import io.homecentr.testcontainers.images.PullPolicyEx;
 import org.junit.After;
 import org.junit.Test;
@@ -28,10 +29,10 @@ public void after() {
 
  @Test
  public void setEnvVarFromSecretFileWhenEnvVarPassed() throws Exception {
- _container = new GenericContainerEx<>(new EnvironmentImageTagResolver(Helpers.getDockerImageFallback()))
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "var-value.txt").toString(), "/var-value.txt")
+ _container = new GenericContainerEx<>(new BaseDockerImageTagResolver())
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "var-value.txt").toString(), "/var-value.txt")
  .withEnv("FILE__TEST_VAR", "/var-value.txt")
  .withImagePullPolicy(PullPolicyEx.never())
  .waitingFor(WaitEx.forS6OverlayStart());
@@ -45,10 +46,10 @@ public void setEnvVarFromSecretFileWhenEnvVarPassed() throws Exception {
 
  @Test
  public void printToOutputThatVariableWasSetWhenEnvVarPassed() throws Exception {
- _container = new GenericContainerEx<>(new EnvironmentImageTagResolver(Helpers.getDockerImageFallback()))
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "var-value.txt").toString(), "/var-value.txt")
+ _container = new GenericContainerEx<>(new BaseDockerImageTagResolver())
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "var-value.txt").toString(), "/var-value.txt")
  .withEnv("FILE__TEST_VAR", "/var-value.txt")
  .withImagePullPolicy(PullPolicyEx.never())
  .waitingFor(WaitEx.forS6OverlayStart());
@@ -60,10 +61,10 @@ public void printToOutputThatVariableWasSetWhenEnvVarPassed() throws Exception {
 
  @Test
  public void printToOutputWhenPassedFileDoesNotExist() throws Exception {
- _container = new GenericContainerEx<>(new EnvironmentImageTagResolver(Helpers.getDockerImageFallback()))
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "var-value.txt").toString(), "/var-value.txt")
+ _container = new GenericContainerEx<>(new BaseDockerImageTagResolver())
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "var-value.txt").toString(), "/var-value.txt")
  .withEnv("FILE__TEST_VAR", "/not-existing.txt")
  .withImagePullPolicy(PullPolicyEx.never())
  .waitingFor(WaitEx.forS6OverlayStart());
@@ -76,10 +77,10 @@ public void printToOutputWhenPassedFileDoesNotExist() throws Exception {
 
  @Test
  public void skipWhenNoVariablesPassed() {
- _container = new GenericContainerEx<>(new EnvironmentImageTagResolver(Helpers.getDockerImageFallback()))
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
- .withRelativeFileSystemBind(Paths.get(Helpers.getExamplesDir(), "var-value.txt").toString(), "/var-value.txt")
+ _container = new GenericContainerEx<>(new BaseDockerImageTagResolver())
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "loop").toString(), "/usr/sbin/loop")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "run").toString(), "/etc/services.d/env-test/run")
+ .withRelativeFileSystemBind(Paths.get(Image.getExamplesDir(), "var-value.txt").toString(), "/var-value.txt")
  .withImagePullPolicy(PullPolicyEx.never())
  .waitingFor(WaitEx.forS6OverlayStart());
 

diff --git a/tests/src/test/java/helpers/BaseDockerImageTagResolver.java b/tests/src/test/java/helpers/BaseDockerImageTagResolver.java
@@ -0,0 +1,9 @@
+package helpers;
+
+import io.homecentr.testcontainers.images.EnvironmentImageTagResolver;
+
+public class BaseDockerImageTagResolver extends EnvironmentImageTagResolver {
+ public BaseDockerImageTagResolver() {
+ super("homecentr/base:local");
+ }
+}
diff --git a/tests/src/test/java/Helpers.java → tests/src/test/java/helpers/Image.java b/tests/src/test/java/Helpers.java → tests/src/test/java/helpers/Image.java
@@ -1,9 +1,8 @@
+package helpers;
+
 import java.nio.file.Paths;
 
-public class Helpers {
- public static String getDockerImageFallback() {
- return "homecentr/base:local-" + getBase();
- }
+public class Image {
 
  public static String getExamplesDir() {
  return Paths.get(