Polishing.

Refactor AuthenticationSteps creation into static factory method. Extend tests, add documentation. See gh-821 Original pull request: gh-853
spring-projects · Jun 6, 2024 · 114f944 · 114f944
1 parent fdcab61
commit 114f944
Show file tree

Hide file tree

Showing 4 changed files with 91 additions and 11 deletions.
diff --git a/...ult-core/src/main/java/org/springframework/vault/authentication/GitHubAuthentication.java b/...ult-core/src/main/java/org/springframework/vault/authentication/GitHubAuthentication.java
@@ -16,8 +16,10 @@
 package org.springframework.vault.authentication;
 
 import java.util.Map;
+
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+
 import org.springframework.util.Assert;
 import org.springframework.vault.VaultException;
 import org.springframework.vault.support.VaultResponse;
@@ -30,6 +32,7 @@
  * personal access token.
  *
  * @author Nanne Baars
+ * @author Mark Paluch
  * @since 3.2
  * @see GitHubAuthentication
  * @see RestOperations
@@ -58,11 +61,24 @@ public GitHubAuthentication(GitHubAuthenticationOptions options, RestOperations
 		this.restOperations = restOperations;
 	}
 
+	/**
+	 * Creates a {@link AuthenticationSteps} for GitHub authentication given
+	 * {@link GitHubAuthenticationOptions}.
+	 * @param options must not be {@literal null}.
+	 * @return {@link AuthenticationSteps} for github authentication.
+	 */
+	public static AuthenticationSteps createAuthenticationSteps(GitHubAuthenticationOptions options) {
+
+		Assert.notNull(options, "GitHubAuthentication must not be null");
+
+		return AuthenticationSteps.fromSupplier(options.getTokenSupplier())
+			.map(GitHubAuthentication::getGitHubLogin)
+			.login(AuthenticationUtil.getLoginPath(options.getPath()));
+	}
+
 	@Override
 	public AuthenticationSteps getAuthenticationSteps() {
-		return AuthenticationSteps.fromSupplier(options.getTokenSupplier())
-			.map(token -> getGitHubLogin(token))
-			.login(AuthenticationUtil.getLoginPath(this.options.getPath()));
+		return createAuthenticationSteps(options);
 	}
 
 	@Override

diff --git a/...e/src/main/java/org/springframework/vault/authentication/GitHubAuthenticationOptions.java b/...e/src/main/java/org/springframework/vault/authentication/GitHubAuthenticationOptions.java
@@ -27,7 +27,6 @@
  * Instances of this class are immutable once constructed.
  *
  * @author Nanne Baars
- * @author Mark Paluch
  * @since 3.2
  * @see GitHubAuthentication
  * @see #builder()

diff --git a/...st/java/org/springframework/vault/authentication/GitHubAuthenticationIntegrationTest.java b/...st/java/org/springframework/vault/authentication/GitHubAuthenticationIntegrationTest.java
@@ -53,10 +53,13 @@ void before() throws Exception {
 			prepare().mountAuth("github");
 		}
 
-		prepare().getVaultOperations()
-			.doWithSession(
-					restOperations -> restOperations.postForEntity("auth/github/config", Map.of("organization_id", 1,
-							"base_url", "http://localhost:%d".formatted(gitHubMockServer.getPort())), Map.class));
+		gitHubMockServer.start();
+
+		prepare().getVaultOperations().doWithSession(restOperations -> {
+			Map<String, String> config = Map.of("organization", "foo", "organization_id", "" + organizationId,
+					"base_url", "http://localhost:%d".formatted(gitHubMockServer.getPort()));
+			return restOperations.postForEntity("auth/github/config", config, Map.class);
+		});
 	}
 
 	@AfterEach
@@ -66,21 +69,45 @@ void after() throws IOException {
 
 	@Test
 	void shouldLoginSuccessfully() {
+
+		GitHubAuthenticationOptions options = GitHubAuthenticationOptions.builder()
+			.tokenSupplier(() -> "TOKEN")
+			.build();
 		RestTemplate restTemplate = TestRestTemplateFactory.create(Settings.createSslConfiguration());
 		setupGithubMockServer(gitHubUserResponse(), gitHubOrganizationResponse(organizationId),
 				gitHubTeamResponse(organizationId));
 
-		GitHubAuthentication authentication = new GitHubAuthentication(
-				GitHubAuthenticationOptions.builder().tokenSupplier(() -> "TOKEN").build(), restTemplate);
+		GitHubAuthentication authentication = new GitHubAuthentication(options, restTemplate);
 		VaultToken loginToken = authentication.login();
 
 		assertThat(loginToken.getToken()).isNotNull();
 	}
 
+	@Test
+	void shouldLoginUsingAuthenticationSteps() {
+
+		GitHubAuthenticationOptions options = GitHubAuthenticationOptions.builder()
+			.tokenSupplier(() -> "TOKEN")
+			.build();
+		RestTemplate restTemplate = TestRestTemplateFactory.create(Settings.createSslConfiguration());
+		setupGithubMockServer(gitHubUserResponse(), gitHubOrganizationResponse(organizationId),
+				gitHubTeamResponse(organizationId));
+
+		AuthenticationSteps steps = GitHubAuthentication.createAuthenticationSteps(options);
+
+		AuthenticationStepsExecutor executor = new AuthenticationStepsExecutor(steps, restTemplate);
+		VaultToken loginToken = executor.login();
+
+		assertThat(loginToken.getToken()).isNotNull();
+	}
+
 	@Test
 	void shouldFailIfOrganizationIsNotTheSame() {
+
 		RestTemplate restTemplate = TestRestTemplateFactory.create(Settings.createSslConfiguration());
-		var wrongOrganizationId = organizationId + 1;
+
+		int wrongOrganizationId = organizationId + 1;
+
 		setupGithubMockServer(gitHubUserResponse(), gitHubOrganizationResponse(wrongOrganizationId),
 				gitHubTeamResponse(wrongOrganizationId));
 

diff --git a/src/main/antora/modules/ROOT/pages/vault/authentication.adoc b/src/main/antora/modules/ROOT/pages/vault/authentication.adoc
@@ -537,6 +537,44 @@ See also:
 * https://cloud.google.com/iam/docs/reference/credentials/rest/v1/projects.serviceAccounts/signJwt
 * https://cloud.google.com/iam/docs/reference/rest/v1/projects.serviceAccounts/signJwt (deprecated)
 
+[[vault.authentication.github]]
+== GitHub Authentication
+
+The https://www.vaultproject.io/docs/auth/github.html[github]
+auth backend provides an authentication mechanism based on GitHub tokens.
+Vault does not support an OAuth workflow to generate GitHub tokens,
+so it does not act as a GitHub application.
+
+The authentication mechanism requires a GitHub token (or a supplier)
+to pass on the token to Vault which then authenticates against your GitHub
+account.
+
+====
+[source,java]
+----
+@Configuration
+class AppConfig extends AbstractVaultConfiguration {
+
+    // …
+
+    @Override
+    public ClientAuthentication clientAuthentication() {
+
+        GitHubAuthentication options = GitHubAuthentication.builder()
+                    .token(…).build();
+
+        return new GitHubAuthentication(options, restOperations());
+    }
+
+    // …
+}
+----
+====
+
+See also:
+
+* https://www.vaultproject.io/api-docs/auth/github[Vault Documentation: GitHub auth method]
+
 [[vault.authentication.pcf]]
 == PCF authentication