Skip to content

Commit

Permalink
Merge pull request gocd#6112 from bdpiparva/fix-typos-in-message
Browse files Browse the repository at this point in the history 
Fixed typos in error message for secret resolution failure.
  • Loading branch information
@bdpiprava
bdpiprava authored Apr 9, 2019
2 parents 1db758f + 3c4c363 commit 485e678
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 15 deletions.
9 changes: 4 additions & 5 deletions ...n/java/com/thoughtworks/go/plugin/access/exceptions/SecretResolutionFailureException.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,12 @@ public SecretResolutionFailureException(String message) {
super(message);
}

public static SecretResolutionFailureException withMissingSecretParams(Set<String> secretsToResolve, Set<String> missingSecrets) {
return new SecretResolutionFailureException(format("Expected plugin to resolve secret(s) `%s` but plugin failed resolve secret param(s) `%s`. Please make sure that secret with same name exist in your secret management tool.", csv(secretsToResolve), csv(missingSecrets)));
public static SecretResolutionFailureException withMissingSecretParams(String secretConfigId, Set<String> secretsToResolve, Set<String> missingSecrets) {
return new SecretResolutionFailureException(format("Expected plugin to resolve secret param(s) `%s` using secret config `%s` but plugin failed to resolve secret param(s) `%s`. Please make sure that secret(s) with the same name exists in your secret management tool.", csv(secretsToResolve), secretConfigId, csv(missingSecrets)));
}


public static SecretResolutionFailureException withUnwantedSecretParams(Set<String> secretsToResolve, Set<String> unwantedSecrets) {
return new SecretResolutionFailureException(format("Expected plugin to resolve secret(s) `%s` but plugin sent addition secret param(s) `%s`.", csv(secretsToResolve), csv(unwantedSecrets)));
public static SecretResolutionFailureException withUnwantedSecretParams(String secretConfigId, Set<String> secretsToResolve, Set<String> unwantedSecrets) {
return new SecretResolutionFailureException(format("Expected plugin to resolve secret param(s) `%s` using secret config `%s` but plugin sent additional secret param(s) `%s`.", csv(secretsToResolve), secretConfigId, csv(unwantedSecrets)));
}

private static String csv(Set<String> secretsToResolve) {
Expand Down
4 changes: 2 additions & 2 deletions ...ugin-access/src/main/java/com/thoughtworks/go/plugin/access/secrets/SecretsExtension.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,15 +81,15 @@ public List<Secret> lookupSecrets(String pluginId, SecretConfig secretConfig, Se

final Set<String> additionalSecretsInResponse = SetUtils.difference(resolvedSecrets, keys).toSet();
if (!additionalSecretsInResponse.isEmpty()) {
throw SecretResolutionFailureException.withUnwantedSecretParams(keys, additionalSecretsInResponse);
throw SecretResolutionFailureException.withUnwantedSecretParams(secretConfig.getId(), keys, additionalSecretsInResponse);
}

if (resolvedSecrets.containsAll(keys)) {
return secrets;
}

final Set<String> missingSecrets = SetUtils.disjunction(resolvedSecrets, keys).toSet();
throw SecretResolutionFailureException.withMissingSecretParams(keys, missingSecrets);
throw SecretResolutionFailureException.withMissingSecretParams(secretConfig.getId(), keys, missingSecrets);
}

protected VersionedSecretsExtension getVersionedSecretsExtension(String pluginId) {
Expand Down
18 changes: 10 additions & 8 deletions ...-access/src/test/java/com/thoughtworks/go/plugin/access/secrets/SecretsExtensionTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,22 +130,23 @@ void validateSecretsConfig_shouldDelegateToVersionedExtension() {
class lookupSecrets {
@Test
void shouldDelegateToVersionedExtension() {
final SecretConfig secretConfig = new SecretConfig("file", "cd.go.secret.file");
SecretsExtensionV1 secretsExtensionV1 = mock(SecretsExtensionV1.class);
Map<String, VersionedSecretsExtension> secretsExtensionMap = singletonMap("1.0", secretsExtensionV1);
extension = new SecretsExtension(pluginManager, extensionsRegistry, secretsExtensionMap);
Set<String> keys = new HashSet<>(asList("key1", "key2"));

when(pluginManager.resolveExtensionVersion(PLUGIN_ID, SECRETS_EXTENSION, SUPPORTED_VERSIONS)).thenReturn(SecretsExtensionV1.VERSION);
when(secretsExtensionV1.lookupSecrets(PLUGIN_ID, new SecretConfig(), keys)).thenReturn(Arrays.asList(
when(secretsExtensionV1.lookupSecrets(PLUGIN_ID, secretConfig, keys)).thenReturn(Arrays.asList(
new Secret("key1", "value-1"),
new Secret("key2", "value-2")
));

final List<Secret> secrets = extension.lookupSecrets(PLUGIN_ID, new SecretConfig(), keys);
final List<Secret> secrets = extension.lookupSecrets(PLUGIN_ID, secretConfig, keys);

assertThat(secrets).hasSize(2)
.contains(new Secret("key1", "value-1"), new Secret("key2", "value-2"));
verify(secretsExtensionV1).lookupSecrets(PLUGIN_ID, new SecretConfig(), keys);
verify(secretsExtensionV1).lookupSecrets(PLUGIN_ID, secretConfig, keys);
}

@Test
Expand All @@ -154,17 +155,18 @@ void shouldBombIfResolvedSecretContainsAdditionalSecrets() {
Map<String, VersionedSecretsExtension> secretsExtensionMap = singletonMap("1.0", secretsExtensionV1);
extension = new SecretsExtension(pluginManager, extensionsRegistry, secretsExtensionMap);
final Set<String> secretsToLookup = new HashSet<>(asList("key1", "key2"));
final SecretConfig secretConfig = new SecretConfig("file", "cd.go.secret.file");

when(pluginManager.resolveExtensionVersion(PLUGIN_ID, SECRETS_EXTENSION, SUPPORTED_VERSIONS)).thenReturn(SecretsExtensionV1.VERSION);
when(secretsExtensionV1.lookupSecrets(PLUGIN_ID, new SecretConfig(), secretsToLookup)).thenReturn(Arrays.asList(
when(secretsExtensionV1.lookupSecrets(PLUGIN_ID, secretConfig, secretsToLookup)).thenReturn(Arrays.asList(
new Secret("key1", "value-1"),
new Secret("key2", "value-2"),
new Secret("key3", "value-3")
));

assertThatCode(() -> extension.lookupSecrets(PLUGIN_ID, new SecretConfig(), secretsToLookup))
assertThatCode(() -> extension.lookupSecrets(PLUGIN_ID, secretConfig, secretsToLookup))
.isInstanceOf(SecretResolutionFailureException.class)
.hasMessage("Expected plugin to resolve secret(s) `key1, key2` but plugin sent addition secret param(s) `key3`.");
.hasMessage("Expected plugin to resolve secret param(s) `key1, key2` using secret config `file` but plugin sent additional secret param(s) `key3`.");
}

@Test
Expand All @@ -177,9 +179,9 @@ void shouldBombWhenPluginReturnsPartiallyResolvedSecretParams() {
when(pluginManager.resolveExtensionVersion(PLUGIN_ID, SECRETS_EXTENSION, SUPPORTED_VERSIONS)).thenReturn(SecretsExtensionV1.VERSION);
when(secretsExtensionV1.lookupSecrets(PLUGIN_ID, new SecretConfig(), secretsToLookup)).thenReturn(singletonList(new Secret("key1", "value-1")));

assertThatCode(() -> extension.lookupSecrets(PLUGIN_ID, new SecretConfig(), secretsToLookup))
assertThatCode(() -> extension.lookupSecrets(PLUGIN_ID, new SecretConfig("file", "cd.go.secret.file"), secretsToLookup))
.isInstanceOf(SecretResolutionFailureException.class)
.hasMessage("Expected plugin to resolve secret(s) `key1, key2, key3` but plugin failed resolve secret param(s) `key2, key3`. Please make sure that secret with same name exist in your secret management tool.");
.hasMessage("Expected plugin to resolve secret param(s) `key1, key2, key3` using secret config `file` but plugin failed to resolve secret param(s) `key1, key2, key3`. Please make sure that secret(s) with the same name exists in your secret management tool.");
}
}

Expand Down

0 comments on commit 485e678

Please sign in to comment.