Fix 20363: Enhancing Acceptance Test Directory Organization (oppia#20364

) * updates * updates * updates * updates
AdityaSinghDevs · May 28, 2024 · e2f9d43 · e2f9d43
1 parent 6345bf8
commit e2f9d43
Show file tree

Hide file tree

Showing 42 changed files with 260 additions and 245 deletions.
diff --git a/.github/workflows/e2e_lighthouse_performance_acceptance_tests.yml b/.github/workflows/e2e_lighthouse_performance_acceptance_tests.yml
@@ -310,22 +310,21 @@ jobs:
         matrix:
           os: [ubuntu-22.04]
           suite:
-            - blog-admin-tests/assign-roles-to-users-and-change-tag-properties
-            - blog-editor-tests/try-to-publish-a-duplicate-blog-post-and-get-blocked
-            - curriculum-admin-tests/create-and-publish-topics-and-stories
-            - exploration-editor-tests/load-complete-and-restart-exploration-preview
-            - exploration-editor-tests/create-exploration-and-change-basic-settings
-            - logged-in-user-tests/click-all-buttons-on-about-page
-            - logged-in-user-tests/click-all-buttons-on-about-foundation-page
-            - logged-in-user-tests/click-all-buttons-on-thanks-for-donating-page
-            - logged-in-user-tests/click-all-buttons-on-navbar
-            - logged-in-user-tests/click-all-links-in-about-oppia-footer
-            - logged-in-user-tests/click-all-links-on-get-started-page
-            - logged-in-user-tests/subscribe-to-creator-and-view-all-explorations-by-that-creator
-            - practice-question-admin-tests/add-and-remove-contribution-rights
-            - translation-admin-tests/add-translation-rights
-            - translation-admin-tests/remove-translation-rights
-            - voiceover-admin-tests/add-voiceover-artist-to-an-exploration
+            - blog-admin/assign-roles-to-users-and-change-tag-properties
+            - blog-editor/try-to-publish-a-duplicate-blog-post-and-get-blocked
+            - curriculum-admin/create-and-publish-topics-and-stories
+            - exploration-editor/load-complete-and-restart-exploration-preview
+            - exploration-editor/create-exploration-and-change-basic-settings
+            - logged-out-user/click-all-buttons-on-about-page
+            - logged-out-user/click-all-buttons-on-about-foundation-page
+            - logged-out-user/click-all-buttons-on-donation-thanks-page
+            - logged-out-user/click-all-buttons-on-navbar
+            - logged-out-user/click-all-links-in-about-oppia-footer
+            - logged-out-user/click-all-links-on-get-started-page
+            - logged-in-user/subscribe-to-creator-and-view-all-explorations-by-that-creator
+            - practice-question-admin/add-and-remove-contribution-rights
+            - translation-admin/add-and-remove-translation-rights
+            - voiceover-admin/add-voiceover-artist-to-an-exploration
       steps:
         - uses: actions/checkout@v3
         - uses: actions/setup-python@v3

diff --git a/Makefile b/Makefile
@@ -184,7 +184,7 @@ run_tests.acceptance: ## Runs the acceptance tests for the parsed suite
 		rm -rf ./core/tests/puppeteer-acceptance-tests/build; \
 	fi
 	../oppia_tools/node-16.13.0/bin/node ./node_modules/typescript/bin/tsc -p ./tsconfig.puppeteer-acceptance-tests.json
-	../oppia_tools/node-16.13.0/bin/node ./node_modules/.bin/jasmine --config="./core/tests/puppeteer-acceptance-tests/jasmine.json" ./core/tests/puppeteer-acceptance-tests/build/spec/$(suite).spec.js
+	../oppia_tools/node-16.13.0/bin/node ./node_modules/.bin/jasmine --config="./core/tests/puppeteer-acceptance-tests/jasmine.json" ./core/tests/puppeteer-acceptance-tests/build/specs/$(suite).spec.js
 	@echo '------------------------------------------------------'
 	@echo '  Acceptance test has been executed successfully....'
 	@echo '------------------------------------------------------'

diff --git a/...ance-tests/images/blog-post-thumbnail.svg → ...ptance-tests/data/blog-post-thumbnail.svg b/...ance-tests/images/blog-post-thumbnail.svg → ...ptance-tests/data/blog-post-thumbnail.svg
diff --git a/...sts/images/curriculum-admin-thumbnail.svg → ...tests/data/curriculum-admin-thumbnail.svg b/...sts/images/curriculum-admin-thumbnail.svg → ...tests/data/curriculum-admin-thumbnail.svg
diff --git a/core/tests/puppeteer-acceptance-tests/jasmine.json b/core/tests/puppeteer-acceptance-tests/jasmine.json
@@ -1,5 +1,5 @@
 {
-  "spec_dir": "core/tests/puppeteer-acceptance-tests/build/spec",
+  "spec_dir": "core/tests/puppeteer-acceptance-tests/build/specs",
   "spec_files": [
     "**/*.spec.js"
   ],

diff --git a/...ts/puppeteer-acceptance-tests/spec/translation-admin-tests/add-translation-rights.spec.ts b/...ts/puppeteer-acceptance-tests/spec/translation-admin-tests/add-translation-rights.spec.ts
diff --git a/...o-users-and-change-tag-properties.spec.ts → ...o-users-and-change-tag-properties.spec.ts b/...o-users-and-change-tag-properties.spec.ts → ...o-users-and-change-tag-properties.spec.ts
@@ -16,10 +16,10 @@
  * @fileoverview Acceptance Test for Blog Admin
  */
 
-import {UserFactory} from '../../puppeteer-testing-utilities/user-factory';
-import testConstants from '../../puppeteer-testing-utilities/test-constants';
-import {BlogAdmin} from '../../user-utilities/blog-admin-utils';
-import {SuperAdmin} from '../../user-utilities/super-admin-utils';
+import {UserFactory} from '../../utilities/common/user-factory';
+import testConstants from '../../utilities/common/test-constants';
+import {BlogAdmin} from '../../utilities/user/blog-admin';
+import {SuperAdmin} from '../../utilities/user/super-admin';
 
 const DEFAULT_SPEC_TIMEOUT_MSECS = testConstants.DEFAULT_SPEC_TIMEOUT_MSECS;
 const ROLES = testConstants.Roles;

diff --git a/...plicate-blog-post-and-get-blocked.spec.ts → ...plicate-blog-post-and-get-blocked.spec.ts b/...plicate-blog-post-and-get-blocked.spec.ts → ...plicate-blog-post-and-get-blocked.spec.ts
@@ -16,10 +16,10 @@
  * @fileoverview Acceptance Test for Blog Post Editor
  */
 
-import {UserFactory} from '../../puppeteer-testing-utilities/user-factory';
-import testConstants from '../../puppeteer-testing-utilities/test-constants';
-import {BlogPostEditor} from '../../user-utilities/blog-post-editor-utils';
-import {ConsoleReporter} from '../../puppeteer-testing-utilities/console-reporter';
+import {UserFactory} from '../../utilities/common/user-factory';
+import testConstants from '../../utilities/common/test-constants';
+import {BlogPostEditor} from '../../utilities/user/blog-post-editor';
+import {ConsoleReporter} from '../../utilities/common/console-reporter';
 
 const DEFAULT_SPEC_TIMEOUT_MSECS = testConstants.DEFAULT_SPEC_TIMEOUT_MSECS;
 const ROLES = testConstants.Roles;

diff --git a/...te-and-publish-topics-and-stories.spec.ts → ...te-and-publish-topics-and-stories.spec.ts b/...te-and-publish-topics-and-stories.spec.ts → ...te-and-publish-topics-and-stories.spec.ts
@@ -16,10 +16,10 @@
  * @fileoverview Acceptance Test for topic management by curriculum admin
  */
 
-import {UserFactory} from '../../puppeteer-testing-utilities/user-factory';
-import testConstants from '../../puppeteer-testing-utilities/test-constants';
-import {CurriculumAdmin} from '../../user-utilities/curriculum-admin-utils';
-import {ExplorationEditor} from '../../user-utilities/exploration-editor-utils';
+import {UserFactory} from '../../utilities/common/user-factory';
+import testConstants from '../../utilities/common/test-constants';
+import {CurriculumAdmin} from '../../utilities/user/curriculum-admin';
+import {ExplorationEditor} from '../../utilities/user/exploration-editor';
 
 const DEFAULT_SPEC_TIMEOUT_MSECS = testConstants.DEFAULT_SPEC_TIMEOUT_MSECS;
 const ROLES = testConstants.Roles;

diff --git a/...oration-and-change-basic-settings.spec.ts → ...oration-and-change-basic-settings.spec.ts b/...oration-and-change-basic-settings.spec.ts → ...oration-and-change-basic-settings.spec.ts
@@ -16,13 +16,13 @@
  * @fileoverview Acceptance Test for Exploration Creator and Exploration Manager
  */
 
-import {ConsoleReporter} from '../../puppeteer-testing-utilities/console-reporter';
-import {showMessage} from '../../puppeteer-testing-utilities/show-message-utils';
-import testConstants from '../../puppeteer-testing-utilities/test-constants';
-import {UserFactory} from '../../puppeteer-testing-utilities/user-factory';
-import {CurriculumAdmin} from '../../user-utilities/curriculum-admin-utils';
-import {ExplorationEditor} from '../../user-utilities/exploration-editor-utils';
-import {VoiceoverAdmin} from '../../user-utilities/voiceover-admin-utils';
+import {UserFactory} from '../../utilities/common/user-factory';
+import testConstants from '../../utilities/common/test-constants';
+import {ConsoleReporter} from '../../utilities/common/console-reporter';
+import {showMessage} from '../../utilities/common/show-message';
+import {CurriculumAdmin} from '../../utilities/user/curriculum-admin';
+import {ExplorationEditor} from '../../utilities/user/exploration-editor';
+import {VoiceoverAdmin} from '../../utilities/user/voiceover-admin';
 
 const DEFAULT_SPEC_TIMEOUT_MSECS = testConstants.DEFAULT_SPEC_TIMEOUT_MSECS;
 const ROLES = testConstants.Roles;

diff --git a/...e-and-restart-exploration-preview.spec.ts → ...e-and-restart-exploration-preview.spec.ts b/...e-and-restart-exploration-preview.spec.ts → ...e-and-restart-exploration-preview.spec.ts
@@ -15,9 +15,9 @@
 /**
  * @fileoverview Acceptance Test for preview tab in exploration editor.
  */
-import {UserFactory} from '../../puppeteer-testing-utilities/user-factory';
-import testConstants from '../../puppeteer-testing-utilities/test-constants';
-import {ExplorationEditor} from '../../user-utilities/exploration-editor-utils';
+import {UserFactory} from '../../utilities/common/user-factory';
+import testConstants from '../../utilities/common/test-constants';
+import {ExplorationEditor} from '../../utilities/user/exploration-editor';
 
 const DEFAULT_SPEC_TIMEOUT_MSECS: number =
   testConstants.DEFAULT_SPEC_TIMEOUT_MSECS;

diff --git a/...acceptance-tests/spec/helpers/reporter.ts → ...cceptance-tests/specs/helpers/reporter.ts b/...acceptance-tests/spec/helpers/reporter.ts → ...cceptance-tests/specs/helpers/reporter.ts
@@ -18,7 +18,7 @@
 
 import util from 'util';
 import sourceMapSupport from 'source-map-support';
-import {ConsoleReporter} from '../../puppeteer-testing-utilities/console-reporter';
+import {ConsoleReporter} from '../../utilities/common/console-reporter';
 
 sourceMapSupport.install();
 

diff --git a/...-all-explorations-by-that-creator.spec.ts → ...-all-explorations-by-that-creator.spec.ts b/...-all-explorations-by-that-creator.spec.ts → ...-all-explorations-by-that-creator.spec.ts
@@ -17,46 +17,46 @@
  * and view all explorations created by that creator
  */
 
-import testConstants from '../../puppeteer-testing-utilities/test-constants';
-import {ExplorationEditor} from '../../user-utilities/exploration-editor-utils';
-import {LoggedInUser} from '../../user-utilities/logged-in-users-utils';
-import {UserFactory} from '../../puppeteer-testing-utilities/user-factory';
+import {UserFactory} from '../../utilities/common/user-factory';
+import testConstants from '../../utilities/common/test-constants';
+import {ExplorationEditor} from '../../utilities/user/exploration-editor';
+import {LoggedInUser} from '../../utilities/user/logged-in-user';
 
 const DEFAULT_SPEC_TIMEOUT = testConstants.DEFAULT_SPEC_TIMEOUT_MSECS;
 
 describe('Logged-in User', function () {
   let testLearner: LoggedInUser;
-  let explorationCreator: ExplorationEditor;
+  let explorationEditor: ExplorationEditor;
 
   beforeAll(async function () {
     testLearner = await UserFactory.createNewUser(
       'testLearner',
       '[email protected]'
     );
-    explorationCreator = await UserFactory.createNewUser(
-      'explorationCreator',
-      'exploration_creator@example.com'
+    explorationEditor = await UserFactory.createNewUser(
+      'explorationEditor',
+      'exploration_editor@example.com'
     );
 
-    await explorationCreator.createAndPublishAMinimalExplorationWithTitle(
+    await explorationEditor.createAndPublishAMinimalExplorationWithTitle(
       'Test Exploration'
     );
   }, DEFAULT_SPEC_TIMEOUT);
 
   it(
     'should subscribe to a creator and view all explorations created by that creator',
     async function () {
-      await explorationCreator.navigateToCreatorDashboardPage();
-      await explorationCreator.expectNumberOfSubscribersToBe(0);
+      await explorationEditor.navigateToCreatorDashboardPage();
+      await explorationEditor.expectNumberOfSubscribersToBe(0);
 
-      await testLearner.navigateToProfilePage('explorationCreator');
-      await testLearner.subscribeToCreator('explorationCreator');
+      await testLearner.navigateToProfilePage('explorationEditor');
+      await testLearner.subscribeToCreator('explorationEditor');
 
-      await explorationCreator.reloadPage();
-      await explorationCreator.expectNumberOfSubscribersToBe(1);
+      await explorationEditor.reloadPage();
+      await explorationEditor.expectNumberOfSubscribersToBe(1);
 
-      await explorationCreator.openSubscribersTab();
-      await explorationCreator.expectUserToBeASubscriber('testLearner');
+      await explorationEditor.openSubscribersTab();
+      await explorationEditor.expectUserToBeASubscriber('testLearner');
 
       await testLearner.expectExplorationToBePresentInProfilePageWithTitle(
         'Test Exploration'

diff --git a/...-buttons-on-about-foundation-page.spec.ts → ...-buttons-on-about-foundation-page.spec.ts b/...-buttons-on-about-foundation-page.spec.ts → ...-buttons-on-about-foundation-page.spec.ts
@@ -17,14 +17,14 @@
  * can open links by clicking all buttons in about foundation page
  */
 
-import {UserFactory} from '../../puppeteer-testing-utilities/user-factory';
-import {LoggedInUser} from '../../user-utilities/logged-in-users-utils';
-import testConstants from '../../puppeteer-testing-utilities/test-constants';
+import {UserFactory} from '../../utilities/common/user-factory';
+import testConstants from '../../utilities/common/test-constants';
+import {LoggedOutUser} from '../../utilities/user/logged-out-user';
 
 const DEFAULT_SPEC_TIMEOUT_MSECS = testConstants.DEFAULT_SPEC_TIMEOUT_MSECS;
 
 describe('Logged-in User in About Foundation page', function () {
-  let testUser: LoggedInUser;
+  let testUser: LoggedOutUser;
 
   beforeAll(async function () {
     testUser = await UserFactory.createNewUser(

diff --git a/...s/click-all-buttons-on-about-page.spec.ts → ...r/click-all-buttons-on-about-page.spec.ts b/...s/click-all-buttons-on-about-page.spec.ts → ...r/click-all-buttons-on-about-page.spec.ts
@@ -17,14 +17,14 @@
  * can open links by clicking all buttons in about foundation page
  */
 
-import {UserFactory} from '../../puppeteer-testing-utilities/user-factory';
-import {LoggedInUser} from '../../user-utilities/logged-in-users-utils';
-import testConstants from '../../puppeteer-testing-utilities/test-constants';
+import {UserFactory} from '../../utilities/common/user-factory';
+import testConstants from '../../utilities/common/test-constants';
+import {LoggedOutUser} from '../../utilities/user/logged-out-user';
 
 const DEFAULT_SPEC_TIMEOUT_MSECS = testConstants.DEFAULT_SPEC_TIMEOUT_MSECS;
 
 describe('Logged-in User in About page', function () {
-  let testUser: LoggedInUser;
+  let testUser: LoggedOutUser;
 
   beforeAll(async function () {
     testUser = await UserFactory.createNewUser(

diff --git a/...ttons-on-thanks-for-donating-page.spec.ts → ...l-buttons-on-donation-thanks-page.spec.ts b/...ttons-on-thanks-for-donating-page.spec.ts → ...l-buttons-on-donation-thanks-page.spec.ts
@@ -17,14 +17,14 @@
  * can open links by clicking all buttons in thanks for donating page
  */
 
-import {UserFactory} from '../../puppeteer-testing-utilities/user-factory';
-import {LoggedInUser} from '../../user-utilities/logged-in-users-utils';
-import testConstants from '../../puppeteer-testing-utilities/test-constants';
+import {UserFactory} from '../../utilities/common/user-factory';
+import testConstants from '../../utilities/common/test-constants';
+import {LoggedOutUser} from '../../utilities/user/logged-out-user';
 
 const DEFAULT_SPEC_TIMEOUT_MSECS = testConstants.DEFAULT_SPEC_TIMEOUT_MSECS;
 
 describe('Logged-in User in Thanks for Donating page', function () {
-  let testUser: LoggedInUser;
+  let testUser: LoggedOutUser;
 
   beforeAll(async function () {
     testUser = await UserFactory.createNewUser(

diff --git a/...tests/click-all-buttons-on-navbar.spec.ts → ...-user/click-all-buttons-on-navbar.spec.ts b/...tests/click-all-buttons-on-navbar.spec.ts → ...-user/click-all-buttons-on-navbar.spec.ts
@@ -17,10 +17,10 @@
  * can open link by clicking all buttons on navbar
  */
 
-import {UserFactory} from '../../puppeteer-testing-utilities/user-factory';
-import {LoggedInUser} from '../../user-utilities/logged-in-users-utils';
-import testConstants from '../../puppeteer-testing-utilities/test-constants';
-import {ConsoleReporter} from '../../puppeteer-testing-utilities/console-reporter';
+import {UserFactory} from '../../utilities/common/user-factory';
+import testConstants from '../../utilities/common/test-constants';
+import {LoggedOutUser} from '../../utilities/user/logged-out-user';
+import {ConsoleReporter} from '../../utilities/common/console-reporter';
 
 const DEFAULT_SPEC_TIMEOUT_MSECS = testConstants.DEFAULT_SPEC_TIMEOUT_MSECS;
 
@@ -31,7 +31,7 @@ ConsoleReporter.setConsoleErrorsToIgnore([
 ]);
 
 describe('Logged-in User', function () {
-  let testUser: LoggedInUser;
+  let testUser: LoggedOutUser;
 
   beforeAll(async function () {
     testUser = await UserFactory.createNewUser(

diff --git a/...k-all-links-in-about-oppia-footer.spec.ts → ...k-all-links-in-about-oppia-footer.spec.ts b/...k-all-links-in-about-oppia-footer.spec.ts → ...k-all-links-in-about-oppia-footer.spec.ts
@@ -17,14 +17,14 @@
  * navigate using all the links under the "About Oppia" footer section.
  */
 
-import {UserFactory} from '../../puppeteer-testing-utilities/user-factory';
-import {LoggedInUser} from '../../user-utilities/logged-in-users-utils';
-import testConstants from '../../puppeteer-testing-utilities/test-constants';
+import {UserFactory} from '../../utilities/common/user-factory';
+import testConstants from '../../utilities/common/test-constants';
+import {LoggedOutUser} from '../../utilities/user/logged-out-user';
 
 const DEFAULT_SPEC_TIMEOUT_MSECS = testConstants.DEFAULT_SPEC_TIMEOUT_MSECS;
 
 describe('Logged-in User', function () {
-  let testUser: LoggedInUser;
+  let testUser: LoggedOutUser;
 
   beforeAll(async function () {
     testUser = await UserFactory.createNewUser(

diff --git a/...ick-all-links-on-get-started-page.spec.ts → ...ick-all-links-on-get-started-page.spec.ts b/...ick-all-links-on-get-started-page.spec.ts → ...ick-all-links-on-get-started-page.spec.ts
@@ -17,14 +17,14 @@
  * can open all the links on the "Get Started" page.
  */
 
-import {UserFactory} from '../../puppeteer-testing-utilities/user-factory';
-import {LoggedInUser} from '../../user-utilities/logged-in-users-utils';
-import testConstants from '../../puppeteer-testing-utilities/test-constants';
+import {UserFactory} from '../../utilities/common/user-factory';
+import testConstants from '../../utilities/common/test-constants';
+import {LoggedOutUser} from '../../utilities/user/logged-out-user';
 
 const DEFAULT_SPEC_TIMEOUT_MSECS = testConstants.DEFAULT_SPEC_TIMEOUT_MSECS;
 
 describe('Logged-in Users', function () {
-  let testUser: LoggedInUser;
+  let testUser: LoggedOutUser;
 
   beforeAll(async function () {
     testUser = await UserFactory.createNewUser(