DockerSpecTests Class — spring-boot Architecture

Source Code

build-plugin/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/tasks/bundling/DockerSpecTests.java lines 42–258

class DockerSpecTests {

	private DockerSpec dockerSpec;

	@BeforeEach
	void prepareDockerSpec(@TempDir File temp) {
		this.dockerSpec = GradleProjectBuilder.builder()
			.withProjectDir(temp)
			.build()
			.getObjects()
			.newInstance(DockerSpec.class);
	}

	@Test
	void asDockerConfigurationWithDefaults() {
		BuilderDockerConfiguration dockerConfiguration = this.dockerSpec.asDockerConfiguration();
		assertThat(dockerConfiguration.connection()).isNull();
		DockerRegistryAuthentication builderRegistryAuthentication = dockerConfiguration
			.builderRegistryAuthentication();
		assertThat(builderRegistryAuthentication).isNotNull();
		assertThat(builderRegistryAuthentication.getAuthHeader()).isNull();
		DockerRegistryAuthentication publishRegistryAuthentication = dockerConfiguration
			.publishRegistryAuthentication();
		assertThat(publishRegistryAuthentication).isNotNull();
		assertThat(decoded(publishRegistryAuthentication.getAuthHeader())).contains("\"username\" : \"\"")
			.contains("\"password\" : \"\"")
			.contains("\"email\" : \"\"")
			.contains("\"serveraddress\" : \"\"");
	}

	@Test
	void asDockerConfigurationWithHostConfiguration() {
		this.dockerSpec.getHost().set("docker.example.com");
		this.dockerSpec.getTlsVerify().set(true);
		this.dockerSpec.getCertPath().set("/tmp/ca-cert");
		BuilderDockerConfiguration dockerConfiguration = this.dockerSpec.asDockerConfiguration();
		DockerConnectionConfiguration.Host host = (DockerConnectionConfiguration.Host) dockerConfiguration.connection();
		assertThat(host).isNotNull();
		assertThat(host.address()).isEqualTo("docker.example.com");
		assertThat(host.secure()).isTrue();
		assertThat(host.certificatePath()).isEqualTo("/tmp/ca-cert");
		assertThat(dockerConfiguration.bindHostToBuilder()).isFalse();
		DockerRegistryAuthentication builderRegistryAuthentication = dockerConfiguration
			.builderRegistryAuthentication();
		assertThat(builderRegistryAuthentication).isNotNull();
		assertThat(builderRegistryAuthentication.getAuthHeader()).isNull();
		DockerRegistryAuthentication publishRegistryAuthentication = dockerConfiguration
			.publishRegistryAuthentication();
		assertThat(publishRegistryAuthentication).isNotNull();
		assertThat(decoded(publishRegistryAuthentication.getAuthHeader())).contains("\"username\" : \"\"")
			.contains("\"password\" : \"\"")
			.contains("\"email\" : \"\"")
			.contains("\"serveraddress\" : \"\"");
	}

	@Test
	void asDockerConfigurationWithHostConfigurationNoTlsVerify() {
		this.dockerSpec.getHost().set("docker.example.com");
		BuilderDockerConfiguration dockerConfiguration = this.dockerSpec.asDockerConfiguration();
		DockerConnectionConfiguration.Host host = (DockerConnectionConfiguration.Host) dockerConfiguration.connection();
		assertThat(host).isNotNull();
		assertThat(host.address()).isEqualTo("docker.example.com");
		assertThat(host.secure()).isFalse();
		assertThat(host.certificatePath()).isNull();
		assertThat(dockerConfiguration.bindHostToBuilder()).isFalse();
		DockerRegistryAuthentication builderRegistryAuthentication = dockerConfiguration
			.builderRegistryAuthentication();
		assertThat(builderRegistryAuthentication).isNotNull();
		assertThat(builderRegistryAuthentication.getAuthHeader()).isNull();
		DockerRegistryAuthentication publishRegistryAuthentication = dockerConfiguration
			.publishRegistryAuthentication();
		assertThat(publishRegistryAuthentication).isNotNull();
		assertThat(decoded(publishRegistryAuthentication.getAuthHeader())).contains("\"username\" : \"\"")
			.contains("\"password\" : \"\"")
			.contains("\"email\" : \"\"")
			.contains("\"serveraddress\" : \"\"");
	}

	@Test
	void asDockerConfigurationWithContextConfiguration() {
		this.dockerSpec.getContext().set("test-context");
		BuilderDockerConfiguration dockerConfiguration = this.dockerSpec.asDockerConfiguration();
		DockerConnectionConfiguration.Context host = (DockerConnectionConfiguration.Context) dockerConfiguration
			.connection();
		assertThat(host).isNotNull();
		assertThat(host.context()).isEqualTo("test-context");
		assertThat(dockerConfiguration.bindHostToBuilder()).isFalse();
		DockerRegistryAuthentication builderRegistryAuthentication = dockerConfiguration
			.builderRegistryAuthentication();
		assertThat(builderRegistryAuthentication).isNotNull();
		assertThat(builderRegistryAuthentication.getAuthHeader()).isNull();
		DockerRegistryAuthentication publishRegistryAuthentication = dockerConfiguration
			.publishRegistryAuthentication();
		assertThat(publishRegistryAuthentication).isNotNull();
		assertThat(decoded(publishRegistryAuthentication.getAuthHeader())).contains("\"username\" : \"\"")
			.contains("\"password\" : \"\"")
			.contains("\"email\" : \"\"")
			.contains("\"serveraddress\" : \"\"");
	}

	@Test
	void asDockerConfigurationWithHostAndContextFails() {
		this.dockerSpec.getContext().set("test-context");
		this.dockerSpec.getHost().set("docker.example.com");
		assertThatExceptionOfType(GradleException.class).isThrownBy(this.dockerSpec::asDockerConfiguration)
			.withMessageContaining("Invalid Docker configuration");
	}

	@Test
	void asDockerConfigurationWithBindHostToBuilder() {
		this.dockerSpec.getHost().set("docker.example.com");
		this.dockerSpec.getBindHostToBuilder().set(true);
		BuilderDockerConfiguration dockerConfiguration = this.dockerSpec.asDockerConfiguration();
		DockerConnectionConfiguration.Host host = (DockerConnectionConfiguration.Host) dockerConfiguration.connection();
		assertThat(host).isNotNull();
		assertThat(host.address()).isEqualTo("docker.example.com");
		assertThat(host.secure()).isFalse();
		assertThat(host.certificatePath()).isNull();
		assertThat(dockerConfiguration.bindHostToBuilder()).isTrue();
		DockerRegistryAuthentication builderRegistryAuthentication = dockerConfiguration
			.builderRegistryAuthentication();
		assertThat(builderRegistryAuthentication).isNotNull();
		assertThat(builderRegistryAuthentication.getAuthHeader()).isNull();
		DockerRegistryAuthentication publishRegistryAuthentication = dockerConfiguration
			.publishRegistryAuthentication();
		assertThat(publishRegistryAuthentication).isNotNull();
		assertThat(decoded(publishRegistryAuthentication.getAuthHeader())).contains("\"username\" : \"\"")
			.contains("\"password\" : \"\"")
			.contains("\"email\" : \"\"")
			.contains("\"serveraddress\" : \"\"");
	}

	@Test
	void asDockerConfigurationWithUserAuth() {
		this.dockerSpec.builderRegistry((registry) -> {
			registry.getUsername().set("user1");
			registry.getPassword().set("secret1");
			registry.getUrl().set("https://docker1.example.com");
			registry.getEmail().set("docker1@example.com");
		});
		this.dockerSpec.publishRegistry((registry) -> {
			registry.getUsername().set("user2");
			registry.getPassword().set("secret2");
			registry.getUrl().set("https://docker2.example.com");
			registry.getEmail().set("docker2@example.com");
		});
		BuilderDockerConfiguration dockerConfiguration = this.dockerSpec.asDockerConfiguration();
		DockerRegistryAuthentication builderRegistryAuthentication = dockerConfiguration
			.builderRegistryAuthentication();
		assertThat(builderRegistryAuthentication).isNotNull();
		assertThat(decoded(builderRegistryAuthentication.getAuthHeader())).contains("\"username\" : \"user1\"")
			.contains("\"password\" : \"secret1\"")
			.contains("\"email\" : \"docker1@example.com\"")
			.contains("\"serveraddress\" : \"https://docker1.example.com\"");
		DockerRegistryAuthentication publishRegistryAuthentication = dockerConfiguration
			.publishRegistryAuthentication();
		assertThat(publishRegistryAuthentication).isNotNull();
		assertThat(decoded(publishRegistryAuthentication.getAuthHeader())).contains("\"username\" : \"user2\"")
			.contains("\"password\" : \"secret2\"")
			.contains("\"email\" : \"docker2@example.com\"")
			.contains("\"serveraddress\" : \"https://docker2.example.com\"");
		assertThat(dockerConfiguration.connection()).isNull();
	}

	@Test
	void asDockerConfigurationWithIncompleteBuilderUserAuthFails() {
		this.dockerSpec.builderRegistry((registry) -> {
			registry.getUsername().set("user1");
			registry.getUrl().set("https://docker1.example.com");
			registry.getEmail().set("docker1@example.com");
		});
		assertThatExceptionOfType(GradleException.class).isThrownBy(this.dockerSpec::asDockerConfiguration)
			.withMessageContaining("Invalid Docker builder registry configuration");
	}

	@Test
	void asDockerConfigurationWithIncompletePublishUserAuthFails() {
		this.dockerSpec.publishRegistry((registry) -> {
			registry.getUsername().set("user2");
			registry.getUrl().set("https://docker2.example.com");
			registry.getEmail().set("docker2@example.com");
		});
		assertThatExceptionOfType(GradleException.class).isThrownBy(this.dockerSpec::asDockerConfiguration)
			.withMessageContaining("Invalid Docker publish registry configuration");
	}

	@Test
	void asDockerConfigurationWithTokenAuth() {
		this.dockerSpec.builderRegistry((registry) -> registry.getToken().set("token1"));
		this.dockerSpec.publishRegistry((registry) -> registry.getToken().set("token2"));
		BuilderDockerConfiguration dockerConfiguration = this.dockerSpec.asDockerConfiguration();
		DockerRegistryAuthentication builderRegistryAuthentication = dockerConfiguration
			.builderRegistryAuthentication();
		assertThat(builderRegistryAuthentication).isNotNull();
		assertThat(decoded(builderRegistryAuthentication.getAuthHeader())).contains("\"identitytoken\" : \"token1\"");
		DockerRegistryAuthentication publishRegistryAuthentication = dockerConfiguration
			.publishRegistryAuthentication();
		assertThat(publishRegistryAuthentication).isNotNull();
		assertThat(decoded(publishRegistryAuthentication.getAuthHeader())).contains("\"identitytoken\" : \"token2\"");
	}

	@Test
	void asDockerConfigurationWithUserAndTokenAuthFails() {
		this.dockerSpec.builderRegistry((registry) -> {
			registry.getUsername().set("user");
			registry.getPassword().set("secret");
			registry.getToken().set("token");
		});
		assertThatExceptionOfType(GradleException.class).isThrownBy(this.dockerSpec::asDockerConfiguration)
			.withMessageContaining("Invalid Docker builder registry configuration");
	}

	@Nullable String decoded(@Nullable String value) {
		return (value != null) ? new String(Base64.getDecoder().decode(value)) : value;
	}

}