WIF engines configurations to one component #29323

Monkeychip · 2025-01-08T22:51:46Z

Description

GCP is the next WIF engine to allow create/edit configuration. While creating it, I noticed it was a near identical copy/paste of the configure-azure component. Thus, I decided to create a shared create/edit configure component called configure-create-edit for all WIF configurable engines. Short-term this includes: AWS, AZURE and soon GCP. Long-term this may include more 🤷‍♀️.

All of these WIF configurations include shared workflows, hence me combining them in a single component:

Access Type options
Issuer modal and network requests
Community vs. Enterprise views
Error flow if either the modal.save() fails and/or issuer.save() fails.

This PR:

Deletes aws-configure and azure-configure components and their component tests.
Does not touch SSH. SSH is also one of the 4 configurable engines (AWS, Azure, GCP and SSH). However, it's configuration workflow is significantly different because it's not WIF configurable and it does some odd generate key things.
Combines the component test but not the acceptance configuration tests for these engines.
Has no user facing changes. GCP will be added in a subsequent PR.
Creates a new helper to help with camelCasing strings or array of strings. This is relevant (and frustrating) in this workflow because checking for a value in a details view— a table row— passes in the attr name with spacing, etc (e.g. data-test-row-label="Identity token audience") vs checking if that form field exists on create-edit view—an input— is done by searching the camelCase (e.g. data-test-input="identityTokenAudience"`). To fix this inconsistency is beyond the scope of this PR and would likely break a lot of previously setup tests.

Note: I renamed and modified the azure-configure component, which is the new combined component—might help to see what changes were required, but also might make it harder to see all the changes together. Apologies.

write test for new string to camelCase helper (maybe pull into separate PR)

github-actions · 2025-01-08T22:55:09Z

CI Results:
All Go tests succeeded! ✅

Monkeychip · 2025-01-09T22:06:47Z

ui/app/components/secret-engine/configure-create-edit.hbs

  <div class="box is-fullwidth is-sideless">
-    {{! accessType can be "azure" or "wif" - since WIF is an enterprise only feature we default to "azure" for community users and only display those related form fields. }}
    {{#if this.version.isEnterprise}}


The layout logic changed some (got easier). Because only WIF engines use this component, we don't have to do any checks for WIF engines. Instead the logic we're concerned with is:

Is this an enterprise version? If "yes" allow users to change the access type

What accessType is currently selected? If it's "account" then show non-wif fields, otherwise show wif fields.

Is there a second config model? If "yes" then show that. Second-config models are not included in accessType or enterprise logic, they should just show if they exist.

Monkeychip · 2025-01-09T22:07:24Z

ui/app/components/secret-engine/configure-create-edit.ts

 import errorMessage from 'vault/utils/error-message';

-import type ConfigModel from 'vault/models/azure/config';
+import type ConfigModel from 'vault/models/secret-engine/config';


I moved all WIF engine config types to the same types model as there was a lot of overlap.

Monkeychip · 2025-01-09T22:08:28Z

ui/app/components/secret-engine/configure-create-edit.ts

 import type IdentityOidcConfigModel from 'vault/models/identity/oidc/config';
 import type Router from '@ember/routing/router';
 import type StoreService from 'vault/services/store';
 import type VersionService from 'vault/services/version';
 import type FlashMessageService from 'vault/services/flash-messages';

 /**
- * @module SecretEngineConfigureAzure component is used to configure the Azure secret engine
- * For enterprise users, they will see an additional option to config WIF attributes in place of Azure account attributes.
+ * @module SecretEngineConfigureCreateEdit component is used to configure WIF_ENGINES (aws, azure)


I'm open to naming changes 🤷‍♀️

Monkeychip · 2025-01-09T22:21:57Z

ui/app/models/aws/root-config.js

+  get isAccountPluginConfigured() {
+    return !!this.accessKey;
+  }
+
  get displayAttrs() {


this looks like I added secretKey to something I shouldn't have. It's a little hard to parse, but the views are still the same. For displayAttrs I filter out secret-key.

Monkeychip · 2025-01-09T22:26:09Z

ui/app/models/ssh/ca-config.js

@@ -38,16 +38,15 @@ export default class SshCaConfig extends Model {
  @attr('string') backend; // dynamic path of secret -- set on response from value passed to queryRecord
  @attr('string', { sensitive: true }) privateKey; // obfuscated, never returned by API
  @attr('string') publicKey;


I know I said I didn't touch SSH, but I did clean up the model to match the pattern of the others.

Monkeychip · 2025-01-09T22:30:23Z

ui/app/routes/vault/cluster/secrets/backend/configuration/edit.ts

@@ -91,6 +106,8 @@ export default class SecretsBackendConfigurationEdit extends Route {
        model['identity-oidc-config'] = { queryIssuerError: true };
      }
    }
+    // add displayName to the model
+    model['displayName'] = displayName;


This saves us a little code as we use displayName at least twice in the edit.hbs file. Instead of calling the method to return displayName, now I can just access it on the model. It's a very small savings, and if this annoys folks, I'm happy to just call the method in its place.

Monkeychip · 2025-01-09T22:40:27Z

ui/app/models/aws/root-config.js

@@ -45,40 +45,50 @@ export default class AwsRootConfig extends Model {
  iamEndpoint;
  @attr('string', { label: 'STS endpoint' }) stsEndpoint;
  @attr('number', {
-    label: 'Maximum retries',


So here's the deal: calling this Maximum when the api attr is Max makes things messy when running through tests. I'm doing and asking for permission later here.

Monkeychip · 2025-01-09T22:45:31Z

ui/tests/integration/components/secret-engine/configure-create-edit-test.js

+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+


This is the "new" component test. A couple of things:

-I did my best to run for loops for the tests that made sense to run on each wif engine.
-I did my best to test once if that tests wasn't dependent on engine type.
-And I did my best to cover all engine specific things.

All that to say, I did my best, but my brain is fried after running through this so many times. If you catch an efficiency, please point it out.

Monkeychip · 2025-01-09T22:47:03Z

ui/tests/integration/components/secret-engine/configuration-details-test.js

@@ -48,16 +48,29 @@ module('Integration | Component | SecretEngine/ConfigurationDetails', function (
      );

      for (const key of expectedConfigKeys(type)) {


this test changed because I made my helper expectedConfigKeys a little easier to read. Instead of creating config arrays the excluded the keys not returned from the api, I just exclude them in the loop and check they're not in the view.

Monkeychip · 2025-01-09T22:48:11Z

ui/tests/helpers/secret-engine/secret-engine-helpers.js

@@ -6,6 +6,7 @@
 import { click, fillIn } from '@ember/test-helpers';
 import { GENERAL } from 'vault/tests/helpers/general-selectors';
 import { SECRET_ENGINE_SELECTORS as SES } from 'vault/tests/helpers/secret-engine/secret-engine-selectors';
+import { stringToCamelCase } from 'vault/helpers/string-to-camel-case';
 import { v4 as uuidv4 } from 'uuid';


some reorganizing that makes this seem like a lot of changes.

Monkeychip added 3 commits January 7, 2025 13:54

initial creation of new component

4ee7920

delete components

bfee742

move ssh back to own components

4b5e4e7

Monkeychip added the ui label Jan 8, 2025

github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Jan 8, 2025

final copy of ssh back

69cefbf

Monkeychip added 6 commits January 8, 2025 16:08

half way through test things

00526fc

remove model types

1f2ae81

clean up

da2d9c4

configure-create-edit is done

12a360b

fix acceptance test for aws

5f054bf

clean up acceptance tests for configurable engines

2a454cd

Monkeychip commented Jan 9, 2025

View reviewed changes

Monkeychip added 2 commits January 9, 2025 15:48

clean up

b8718fd

🧹

40f74d5

Monkeychip mentioned this pull request Jan 10, 2025

Prep work for creating one WIF configuration component #29345

Merged

1 task

Monkeychip closed this Jan 17, 2025

Monkeychip deleted the ui/VAULT-33327/one-config-component branch January 17, 2025 21:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIF engines configurations to one component #29323

WIF engines configurations to one component #29323

Monkeychip commented Jan 8, 2025 •

edited

Loading

github-actions bot commented Jan 8, 2025 •

edited

Loading

Monkeychip Jan 9, 2025 •

edited

Loading

Monkeychip Jan 9, 2025 •

edited

Loading

Monkeychip Jan 9, 2025

Monkeychip Jan 9, 2025

Monkeychip Jan 9, 2025

Monkeychip Jan 9, 2025

Monkeychip Jan 9, 2025 •

edited

Loading

Monkeychip Jan 9, 2025 •

edited

Loading

Monkeychip Jan 9, 2025

Monkeychip Jan 9, 2025

		@@ -48,16 +48,29 @@ module('Integration \| Component \| SecretEngine/ConfigurationDetails', function (
		);

		for (const key of expectedConfigKeys(type)) {

WIF engines configurations to one component #29323

WIF engines configurations to one component #29323

Conversation

Monkeychip commented Jan 8, 2025 • edited Loading

Description

github-actions bot commented Jan 8, 2025 • edited Loading

Monkeychip Jan 9, 2025 • edited Loading

Choose a reason for hiding this comment

Monkeychip Jan 9, 2025 • edited Loading

Choose a reason for hiding this comment

Monkeychip Jan 9, 2025

Choose a reason for hiding this comment

Monkeychip Jan 9, 2025

Choose a reason for hiding this comment

Monkeychip Jan 9, 2025

Choose a reason for hiding this comment

Monkeychip Jan 9, 2025

Choose a reason for hiding this comment

Monkeychip Jan 9, 2025 • edited Loading

Choose a reason for hiding this comment

Monkeychip Jan 9, 2025 • edited Loading

Choose a reason for hiding this comment

Monkeychip Jan 9, 2025

Choose a reason for hiding this comment

Monkeychip Jan 9, 2025

Choose a reason for hiding this comment

Monkeychip commented Jan 8, 2025 •

edited

Loading

github-actions bot commented Jan 8, 2025 •

edited

Loading

Monkeychip Jan 9, 2025 •

edited

Loading

Monkeychip Jan 9, 2025 •

edited

Loading

Monkeychip Jan 9, 2025 •

edited

Loading

Monkeychip Jan 9, 2025 •

edited

Loading