PARTIAL Add VoiceOver Bot

client/utils/automation.js

@@ -3,14 +3,24 @@ export const isSupportedByResponseCollector = ctx => {
         return false;
     }
     return (
-        ctx.at.name === 'NVDA' &&
-        (ctx.browser.name === 'Chrome' || ctx.browser.name === 'Firefox')
+        (ctx.at.name === 'NVDA' &&
+            (ctx.browser.name === 'Chrome' ||
+                ctx.browser.name === 'Firefox')) ||
+        (ctx.at.name === 'VoiceOver' && ctx.browser.name === 'Safari')
     );
 };
 
-// TODO: Stub, support for more bot users should be added
+/**
+ * @param {} [at]
+ * @param {} [browser]
+ *
+ * @returns {string|undefined}
+ */
 export const getBotUsernameFromAtBrowser = (at, browser) => {
     if (at?.name === 'NVDA' && browser?.name === 'Chrome') {
         return 'NVDA Bot';
     }
+    if (at?.name === 'VoiceOver' && browser?.name === 'Safari') {
+        return 'Safari Bot';
+    }
 };

server/models/services/CollectionJobService.js

@@ -17,7 +17,7 @@ const {
     createTestPlanRun,
     removeTestPlanRunById
 } = require('./TestPlanRunService');
-const responseCollectionUser = require('../../util/responseCollectionUser');
+const responseCollectionUserIDs = require('../../util/responseCollectionUserIDs');
 const { getTestPlanReportById } = require('./TestPlanReportService');
 const { HttpQueryError } = require('apollo-server-core');
 const { default: axios } = require('axios');
@@ -188,7 +188,11 @@ const collectionJobTestStatusAssociation =
 
 /**
  * @param {object} options
- * @param {object} options.values - CollectionJob to be created
+ * @param {object} options.values
+ * @param {string} options.values.status - Status of CollectionJob to be created
+ * @param {number} options.values.testerUserId - ID of the Tester to which the CollectionJob should be assigned
+ * @param {object} options.values.testPlanReportId - ID of the TestPlan with which the CollectionJob should be associated
+ * @param {object} [options.values.testPlanRun] - TestPlan with wich the CollectionJob should be associated (if not provided, a new TestPlan will be created)
  * @param {string[]} options.collectionJobAttributes - CollectionJob attributes to be returned in the result
  * @param {string[]} options.collectionJobTestStatusAttributes - CollectionJobTestStatus attributes to be returned in the result
  * @param {string[]} options.testPlanReportAttributes - TestPlanReport attributes to be returned in the result
@@ -203,6 +207,7 @@ const collectionJobTestStatusAssociation =
 const createCollectionJob = async ({
     values: {
         status = COLLECTION_JOB_STATUS.QUEUED,
+        testerUserId,
         testPlanRun,
         testPlanReportId
     },
@@ -220,7 +225,7 @@ const createCollectionJob = async ({
     if (!testPlanRun) {
         testPlanRun = await createTestPlanRun({
             values: {
-                testerUserId: responseCollectionUser.id,
+                testerUserId,
                 testPlanReportId: testPlanReportId,
                 isAutomated: true
             },
@@ -538,6 +543,7 @@ const scheduleCollectionJob = async (
     const tests = await runnableTestsResolver(report, null, context);
     const { directory } = report.testPlanVersion.testPlan;
     const { gitSha } = report.testPlanVersion;
+    const testerUserId = responseCollectionUserIDs['NVDA Bot'];
 
     if (!tests || tests.length === 0) {
         throw new Error(
@@ -560,6 +566,7 @@ const scheduleCollectionJob = async (
     const job = await createCollectionJob({
         values: {
             status: COLLECTION_JOB_STATUS.QUEUED,
+            testerUserId,
             testPlanReportId
         },
         transaction

server/models/services/UserService.js

@@ -148,6 +148,10 @@ const getUsers = async ({
     });
 };
 
+/**
+ */
+const getBotByAt = async ({ transaction }) => {};
+
 /**
  * @param {object} options
  * @param {string|any} options.search - use this to combine with {@param filter} to be passed to Sequelize's where clause
@@ -464,6 +468,7 @@ module.exports = {
     getUserById,
     getUserByUsername,
     getUsers,
+    getBotByAt,
     getUserRoles,
     getUserAts,
     createUser,

server/seeders/20231218191524-addNVDABot.js

@@ -1,16 +1,16 @@
 'use strict';
 
-const responseCollectionUser = require('../util/responseCollectionUser');
+const responseCollectionUserIDs = require('../util/responseCollectionUserIDs');
 
 module.exports = {
     async up(queryInterface) {
         const user = await queryInterface.bulkInsert(
             'User',
             [
                 {
-                    id: responseCollectionUser.id, // Specified ID for NVDA Bot
-                    username: responseCollectionUser.username,
-                    isBot: responseCollectionUser.isBot,
+                    id: responseCollectionUserIDs['NVDA Bot'],
+                    username: 'NVDA Bot',
+                    isBot: true,
                     createdAt: new Date(),
                     updatedAt: new Date()
                 }
@@ -28,7 +28,7 @@ module.exports = {
 
     async down(queryInterface) {
         await queryInterface.bulkDelete('User', {
-            id: responseCollectionUser.id
+            id: responseCollectionUserIDs['NVDA Bot']
         });
     }
 };

server/seeders/20240516191524-addVoiceOverBot.js

@@ -0,0 +1,34 @@
+'use strict';
+
+const responseCollectionUserIDs = require('../util/responseCollectionUserIDs');
+
+module.exports = {
+    async up(queryInterface) {
+        const user = await queryInterface.bulkInsert(
+            'User',
+            [
+                {
+                    id: responseCollectionUserIDs['VoiceOver Bot'],
+                    username: 'VoiceOver Bot',
+                    isBot: true,
+                    createdAt: new Date(),
+                    updatedAt: new Date()
+                }
+            ],
+            { returning: true }
+        );
+
+        await queryInterface.bulkInsert('UserRoles', [
+            {
+                userId: user[0].id,
+                roleName: 'TESTER'
+            }
+        ]);
+    },
+
+    async down(queryInterface) {
+        await queryInterface.bulkDelete('User', {
+            id: responseCollectionUserIDs['VoiceOver Bot']
+        });
+    }
+};

server/tests/models/services/UserService.test.js

@@ -334,4 +334,8 @@ describe('UserModel Data Checks', () => {
         expect(user1Ats[0].userId).toBe(_userId);
         expect(user1Ats[0].atId).toBeTruthy();
     });
+
+    describe('getBotByAt', () => {
+        it('should do things', async () => {});
+    });
 });

server/util/responseCollectionUserIDs.js

@@ -0,0 +1,4 @@
+module.exports = {
+    'NVDA Bot': 9999,
+    'VoiceOver Bot': 9998
+};