feat(api): Add isVisible to usecase

1024pix · Feb 5, 2025 · 69114ed · 69114ed
1 parent 453638c
commit 69114ed
Show file tree

Hide file tree

Showing 3 changed files with 90 additions and 0 deletions.
diff --git a/api/src/identity-access-management/domain/usecases/add-oidc-provider.js b/api/src/identity-access-management/domain/usecases/add-oidc-provider.js
@@ -23,6 +23,7 @@
  * @param {boolean} params.shouldCloseSession
  * @param {string} params.slug
  * @param {string} params.source
+ * @param {boolean} params.isVisible
  * @param {OidcProviderRepository} params.oidcProviderRepository
  * @param {CryptoService} params.cryptoService
  * @returns {Promise<void>}
@@ -47,6 +48,7 @@ const addOidcProvider = async function ({
   shouldCloseSession,
   slug,
   source,
+  isVisible = true,
   oidcProviderRepository,
   cryptoService,
   addOidcProviderValidator,
@@ -71,6 +73,7 @@ const addOidcProvider = async function ({
     shouldCloseSession,
     slug,
     source,
+    isVisible,
   });
 
   const encryptedClientSecret = await cryptoService.encrypt(clientSecret);
@@ -95,6 +98,7 @@ const addOidcProvider = async function ({
     shouldCloseSession,
     slug,
     source,
+    isVisible,
   });
 };
 

diff --git a/api/src/identity-access-management/domain/validators/add-oidc-provider.validator.js b/api/src/identity-access-management/domain/validators/add-oidc-provider.validator.js
@@ -28,6 +28,7 @@ const schema = Joi.object({
   shouldCloseSession: Joi.boolean().optional().default(false),
   slug: Joi.string().required(),
   source: Joi.string().optional(),
+  isVisible: Joi.boolean().optional().default(true),
 });
 
 /**

diff --git a/api/tests/identity-access-management/unit/domain/usecases/add-oidc-provider_test.js b/api/tests/identity-access-management/unit/domain/usecases/add-oidc-provider_test.js
@@ -46,6 +46,7 @@ describe('Unit | Identity Access Management | Domain | UseCases | add-oidc-provi
       shouldCloseSession: true,
       slug: 'oidc-example-net',
       source: 'oidcexamplenet',
+      isVisible: true,
     };
 
     // when
@@ -77,6 +78,90 @@ describe('Unit | Identity Access Management | Domain | UseCases | add-oidc-provi
       shouldCloseSession: true,
       slug: 'oidc-example-net',
       source: 'oidcexamplenet',
+      isVisible: true,
+    });
+    expect(cryptoService.encrypt).to.have.been.calledWithExactly('secret');
+    expect(oidcProviderRepository.create).to.have.been.calledWithExactly(expectedOidcProviderProperties);
+  });
+
+  it('creates an OIDC Provider in the oidc-provider-repository and visibility to false', async function () {
+    // given
+    const oidcProviderRepository = {
+      create: sinon.stub(),
+    };
+    const cryptoService = {
+      encrypt: sinon.stub().resolves('#%@!!!!!!!!!!!!!'),
+    };
+    const addOidcProviderValidator = {
+      validate: sinon.stub(),
+    };
+    const oidcProviderProperties = {
+      accessTokenLifespan: '7d',
+      clientId: 'client',
+      clientSecret: 'secret',
+      shouldCloseSession: true,
+      identityProvider: 'OIDC_EXAMPLE_NET',
+      openidConfigurationUrl: 'https://oidc.example.net/.well-known/openid-configuration',
+      organizationName: 'OIDC Example',
+      redirectUri: 'https://app.dev.pix.org/connexion/oidc-example-net',
+      scope: 'openid profile',
+      slug: 'oidc-example-net',
+      source: 'oidcexamplenet',
+      isVisible: false,
+    };
+    const expectedOidcProviderProperties = {
+      accessTokenLifespan: '7d',
+      additionalRequiredProperties: undefined,
+      claimMapping: undefined,
+      claimsToStore: undefined,
+      clientId: 'client',
+      enabled: undefined,
+      enabledForPixAdmin: undefined,
+      encryptedClientSecret: '#%@!!!!!!!!!!!!!',
+      extraAuthorizationUrlParameters: undefined,
+      identityProvider: 'OIDC_EXAMPLE_NET',
+      openidClientExtraMetadata: undefined,
+      openidConfigurationUrl: 'https://oidc.example.net/.well-known/openid-configuration',
+      organizationName: 'OIDC Example',
+      postLogoutRedirectUri: undefined,
+      redirectUri: 'https://app.dev.pix.org/connexion/oidc-example-net',
+      scope: 'openid profile',
+      shouldCloseSession: true,
+      slug: 'oidc-example-net',
+      source: 'oidcexamplenet',
+      isVisible: false,
+    };
+
+    // when
+    await addOidcProvider({
+      ...oidcProviderProperties,
+      oidcProviderRepository,
+      cryptoService,
+      addOidcProviderValidator,
+    });
+
+    // then
+    expect(addOidcProviderValidator.validate).to.have.been.calledWith({
+      accessTokenLifespan: '7d',
+      additionalRequiredProperties: undefined,
+      claimMapping: undefined,
+      claimsToStore: undefined,
+      clientId: 'client',
+      clientSecret: 'secret',
+      enabled: undefined,
+      enabledForPixAdmin: undefined,
+      extraAuthorizationUrlParameters: undefined,
+      identityProvider: 'OIDC_EXAMPLE_NET',
+      openidClientExtraMetadata: undefined,
+      openidConfigurationUrl: 'https://oidc.example.net/.well-known/openid-configuration',
+      organizationName: 'OIDC Example',
+      postLogoutRedirectUri: undefined,
+      redirectUri: 'https://app.dev.pix.org/connexion/oidc-example-net',
+      scope: 'openid profile',
+      shouldCloseSession: true,
+      slug: 'oidc-example-net',
+      source: 'oidcexamplenet',
+      isVisible: false,
     });
     expect(cryptoService.encrypt).to.have.been.calledWithExactly('secret');
     expect(oidcProviderRepository.create).to.have.been.calledWithExactly(expectedOidcProviderProperties);