review PR

1024pix · Sep 2, 2022 · e7351d3 · e7351d3
1 parent e9151a0
commit e7351d3
Show file tree

Hide file tree

Showing 9 changed files with 72 additions and 42 deletions.
diff --git a/common/controllers/index.js b/common/controllers/index.js
@@ -6,7 +6,7 @@ const {
   sampleView: releaseTagSelection,
 } = require('../../run/services/slack/surfaces/modals/deploy-release/release-tag-selection');
 const {
-  sampleView: CreateAppOnScalingoSelection,
+  sampleView: createAppOnScalingoSelection,
 } = require('../../run/services/slack/surfaces/modals/scalingo-apps/application-creation');
 const {
   sampleView: releaseDeploymentConfirmation,
@@ -31,7 +31,7 @@ module.exports = {
     const views = [
       { name: 'release-type-selection', view: releaseTypeSelection() },
       { name: 'release-tag-selection', view: releaseTagSelection() },
-      { name: 'create-app-on-scalingo', view: CreateAppOnScalingoSelection() },
+      { name: 'create-app-on-scalingo', view: createAppOnScalingoSelection() },
       { name: 'release-deployment-confirmation', view: releaseDeploymentConfirmation() },
       { name: 'release-publication-confirmation', view: releasePublicationConfirmation() },
       { name: 'application-creation-confirmation', view: submitApplicationNameSelection() },

diff --git a/common/models/ScalingoAppName.js b/common/models/ScalingoAppName.js
@@ -1,14 +1,14 @@
 //TODO use EnvVars
 const config = require('../../config');
-const regexp = /^([a-zA-Z0-9]+-)+[a-zA-Z0-9]+$/;
-
+const alphanumericAndDashOnly = /^([a-zA-Z0-9]+-)+[a-zA-Z0-9]+$/;
+const prefix = 'pix-';
 class ScalingoAppName {
-  static isValidAppName(applicationName) {
-    const scalingoAppNameSuffix = config.scalingo.validAppSuffix;
-    const appNameMatchesRegex = applicationName.search(regexp) >= 0;
+  static isApplicationNameValid(applicationName) {
+    const suffix = config.scalingo.validAppSuffix;
+    const appNameMatchesRegex = applicationName.search(alphanumericAndDashOnly) >= 0;
     const appNameHasCorrectLength = applicationName.length >= 6 && applicationName.length <= 46;
-    const appNameStartsWithPix = applicationName.startsWith('pix-');
-    const appNameEndsWithCorrectSuffix = scalingoAppNameSuffix.includes(applicationName.split('-').slice(-1)[0]);
+    const appNameStartsWithPix = applicationName.startsWith(prefix);
+    const appNameEndsWithCorrectSuffix = suffix.includes(applicationName.split('-').slice(-1)[0]);
     return appNameMatchesRegex && appNameHasCorrectLength && appNameStartsWithPix && appNameEndsWithCorrectSuffix;
   }
 }

diff --git a/common/services/scalingo-client.js b/common/services/scalingo-client.js
@@ -11,7 +11,6 @@ class ScalingoClient {
   }
 
   static async getInstance(environment) {
-    console.log(environment);
     const { token, apiUrl } = config.scalingo[environment];
     console.log(token, apiUrl);
     const client = await scalingo.clientFromToken(token, { apiUrl });
@@ -85,14 +84,14 @@ class ScalingoClient {
       throw err;
     }
   }
-  async inviteCollaborator(appId, email) {
-    const { invitation_link } = await this.client.Collaborators.invite(appId, email);
+  async inviteCollaborator(applicationId, collaboratorEmail) {
+    const { invitation_link } = await this.client.Collaborators.invite(applicationId, collaboratorEmail);
     return invitation_link;
   }
 
-  async createApp(appName) {
+  async createApplication(name) {
     const app = {
-      name: appName,
+      name: name,
     };
     const { id } = await this.client.Apps.create(app);
     return id;

diff --git a/run/services/slack/shortcuts.js b/run/services/slack/shortcuts.js
@@ -2,6 +2,7 @@ const axios = require('axios');
 const deployReleaseTagSelectionModal = require('./surfaces/modals/deploy-release/release-tag-selection');
 const createAppOnScalingoModal = require('./surfaces/modals/scalingo-apps/application-creation');
 const config = require('../../../config');
+const openViewUrl = 'https://slack.com/api/views.open';
 
 module.exports = {
   openViewDeployReleaseTagSelectionCallbackId: deployReleaseTagSelectionModal.callbackId,
@@ -11,7 +12,7 @@ module.exports = {
   openViewDeployReleaseTagSelection(payload) {
     const options = {
       method: 'POST',
-      url: 'https://slack.com/api/views.open',
+      url: openViewUrl,
       headers: {
         'content-type': 'application/json',
         authorization: `Bearer ${config.slack.botToken}`,
@@ -24,7 +25,7 @@ module.exports = {
   openViewCreateAppOnScalingoSelection(payload) {
     const options = {
       method: 'POST',
-      url: 'https://slack.com/api/views.open',
+      url: openViewUrl,
       headers: {
         'content-type': 'application/json',
         authorization: `Bearer ${config.slack.botToken}`,

diff --git a/run/services/slack/surfaces/modals/scalingo-apps/application-creation-confirmation.js b/run/services/slack/surfaces/modals/scalingo-apps/application-creation-confirmation.js
@@ -15,7 +15,7 @@ function modal(applicationName, applicationEnvironment, userEmail) {
     close: 'Annuler',
   }).blocks([
     Blocks.Section({
-      text: `Vous vous apprêtez à créer l'application *${applicationName}* en *${applicationEnvironment}* avec ${userEmail} en collab. `,
+      text: `Vous vous apprêtez à créer l'application *${applicationName}* en *${applicationEnvironment}* et à inviter cet adesse email en tant que collaborateur : *${userEmail}*`,
     }),
   ]);
 }
@@ -28,7 +28,7 @@ module.exports = (applicationName, applicationEnvironment, userEmail) => {
 };
 
 module.exports.sampleView = () => {
-  return modal('pix-application-name-recette', 'recette', 'pixou@pix.fr');
+  return modal('pix-application-name-recette', 'recette', 'john.doe@pix.fr');
 };
 
 module.exports.callbackId = callbackId;
diff --git a/run/services/slack/surfaces/modals/scalingo-apps/application-creation.js b/run/services/slack/surfaces/modals/scalingo-apps/application-creation.js
@@ -22,8 +22,8 @@ function modal() {
         initialValue: 'pix-super-application-recette',
       })
     ),
-    Blocks.Input({ blockId: 'application-env', label: 'Quelle region ?' }).element(
-      Elements.StaticSelect({ placeholder: 'Choisis ta région' })
+    Blocks.Input({ blockId: 'application-env', label: 'Quelle région ?' }).element(
+      Elements.StaticSelect({ placeholder: 'Choisis la région' })
         .actionId('item')
         .options(regions.map((item) => Bits.Option({ text: item.name, value: item.id })))
     ),

diff --git a/run/services/slack/view-submissions.js b/run/services/slack/view-submissions.js
@@ -19,7 +19,7 @@ module.exports = {
     const applicationEnvironment =
       payload.view.state.values['application-env']['item']['selected_option']['text']['text'];
     const userEmail = await slackGetUserInfos.getUserEmail(payload.user.id);
-    if (!ScalingoAppName.isValidAppName(applicationName)) {
+    if (!ScalingoAppName.isApplicationNameValid(applicationName)) {
       return `${applicationName} is incorrect`;
     }
     return openModalApplicationCreationConfirmation(applicationName, applicationEnvironment, userEmail);
@@ -44,8 +44,7 @@ module.exports = {
   async submitCreateAppOnScalingoConfirmation(payload) {
     const { applicationName, applicationEnvironment, userEmail } = JSON.parse(payload.view.private_metadata);
     const client = await ScalingoClient.getInstance(applicationEnvironment);
-    //TODO check if user email exist
-    const appId = await client.createApp(applicationName);
+    const appId = await client.createAplication(applicationName);
     const invitationLink = await client.inviteCollaborator(appId, userEmail);
     const message = `app ${applicationName} created <${invitationLink}|invitation link>`;
     slackPostMessageService.postMessage(message);

diff --git a/test/acceptance/run/slack_test.js b/test/acceptance/run/slack_test.js
@@ -275,12 +275,12 @@ describe('Acceptance | Run | Slack', function () {
                   block_id: 'application-env',
                   label: {
                     type: 'plain_text',
-                    text: 'Quelle region ?',
+                    text: 'Quelle région ?',
                   },
                   element: {
                     placeholder: {
                       type: 'plain_text',
-                      text: 'Choisis ta région',
+                      text: 'Choisis la région',
                     },
                     action_id: 'item',
                     options: [
@@ -313,12 +313,14 @@ describe('Acceptance | Run | Slack', function () {
           callback_id: 'scalingo-app-creation',
           trigger_id: 'payload id',
         };
+        // when
         const res = await server.inject({
           method: 'POST',
           url: '/run/slack/interactive-endpoint',
           headers: createSlackWebhookSignatureHeaders(JSON.stringify(body)),
           payload: body,
         });
+        // then
         expect(res.statusCode).to.equal(204);
         expect(slackCall.isDone()).to.be.true;
       });
@@ -329,7 +331,7 @@ describe('Acceptance | Run | Slack', function () {
             ok: true,
             user: {
               profile: {
-                email: 'pixou@pix.fr',
+                email: 'john.doe@pix.fr',
               },
             },
           };
@@ -386,7 +388,7 @@ describe('Acceptance | Run | Slack', function () {
               },
               callback_id: 'application-creation-confirmation',
               private_metadata:
-                '{"applicationName":"pix-application-de-folie-recette","applicationEnvironment":"recette","userEmail":"pixou@pix.fr"}',
+                '{"applicationName":"pix-application-de-folie-recette","applicationEnvironment":"recette","userEmail":"john.doe@pix.fr"}',
               close: {
                 type: 'plain_text',
                 text: 'Annuler',
@@ -395,7 +397,7 @@ describe('Acceptance | Run | Slack', function () {
                 {
                   text: {
                     type: 'mrkdwn',
-                    text: "Vous vous apprêtez à créer l'application *pix-application-de-folie-recette* en *recette* avec pixou@pix.fr en collab. ",
+                    text: "Vous vous apprêtez à créer l'application *pix-application-de-folie-recette* en *recette* et à inviter cet adesse email en tant que collaborateur : *john.doe@pix.fr*",
                   },
                   type: 'section',
                 },

diff --git a/test/unit/common/models/ScalingoAppName_test.js b/test/unit/common/models/ScalingoAppName_test.js
@@ -3,36 +3,65 @@ const { expect } = require('../../../test-helper');
 const { ScalingoAppName } = require('../../../../common/models/ScalingoAppName');
 
 describe('Unit | Common | Models | ScalingoAppName', function () {
-  describe('#isValidAppName', function () {
-    it('should return false if appName is not a valid appName', function () {
+  describe('#isApplicationNameValid', function () {
+    it('should return false if appName contains non alphanum or dash char', function () {
+      // given
+      const invalidAppName = 'pix#-application-nameat-production';
+
+      // when
+      const resultInvalidAppName = ScalingoAppName.isApplicationNameValid(invalidAppName);
+      console.log(resultInvalidAppName);
+      // then
+      expect(resultInvalidAppName, 'Invalid app name').to.be.false;
+    });
+
+    it('should return false if appName does not start with pix', function () {
       // given
-      const invalidAppName = '_"zz-fail-pix-app-name-format';
       const doesNotStartWithPixAppName = 'app-name-format';
-      const tooShortAppName = 'pix-a';
-      const tooLongAppName = 'pix-application-with-a-long-name-that-does-not-fit-production';
-      const incorrectSuffixAppName = 'pix-coucou-app-name-mauvaissuffix';
 
       // when
-      const resultInvalidAppName = ScalingoAppName.isValidAppName(invalidAppName);
-      const resultDoesNotStartWithPixAppName = ScalingoAppName.isValidAppName(doesNotStartWithPixAppName);
-      const resultTooShortAppName = ScalingoAppName.isValidAppName(tooShortAppName);
-      const resultTooLongAppName = ScalingoAppName.isValidAppName(tooLongAppName);
-      const resultIncorrectSuffixAppName = ScalingoAppName.isValidAppName(incorrectSuffixAppName);
+      const resultDoesNotStartWithPixAppName = ScalingoAppName.isApplicationNameValid(doesNotStartWithPixAppName);
 
       // then
-      expect(resultInvalidAppName, 'Invalid app name').to.be.false;
       expect(resultDoesNotStartWithPixAppName, 'Does not start with pix app name').to.be.false;
+    });
+
+    it('should return false if appName is too short', function () {
+      // given
+      const tooShortAppName = 'pix-a';
+
+      // when
+      const resultTooShortAppName = ScalingoAppName.isApplicationNameValid(tooShortAppName);
+
+      // then
       expect(resultTooShortAppName, 'Too short app name').to.be.false;
+    });
+    it('should return false if appName is too long', function () {
+      // given
+      const tooLongAppName = 'pix-application-with-a-long-name-that-does-not-fit-production';
+
+      // when
+      const resultTooLongAppName = ScalingoAppName.isApplicationNameValid(tooLongAppName);
+
+      // then
       expect(resultTooLongAppName, 'Too long app name').to.be.false;
-      expect(resultIncorrectSuffixAppName, 'Incorrect suffix app name').to.be.false;
     });
+    it('should return false if appName end with incorrect suffix', function () {
+      // given
+      const incorrectSuffixAppName = 'pix-coucou-app-name-mauvaissuffix';
+
+      // when
+      const resultIncorrectSuffixAppName = ScalingoAppName.isApplicationNameValid(incorrectSuffixAppName);
 
+      // then
+      expect(resultIncorrectSuffixAppName, 'Incorrect suffix app name').to.be.false;
+    });
     it('should return true if parameter is a valid appName', function () {
       // given
       const validAppName = 'pix-super-application-recette';
 
       // when
-      const result = ScalingoAppName.isValidAppName(validAppName);
+      const result = ScalingoAppName.isApplicationNameValid(validAppName);
 
       // then
       expect(result).to.be.true;