core/tests/webdriverio_utils/workflow.js - develop - githubmirror/oppia

core/tests/webdriverio_utils/workflow.js
567 строк20 KB
Sean Lip
Fix #23201: Try to fix some e2e and acceptance tests. Add debug info. (#24011)
12 дек 2025, 01:39
12 дек 2025, 01:39f652db8
// Copyright 2022 The Oppia Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS-IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * @fileoverview Utilities for exploration creation, publication ect. when
 * carrrying out end-to-end testing with webdriverio.
 */

var forms = require('./forms.js');
var path = require('path');
var waitFor = require('./waitFor.js');
var action = require('./action.js');
var CreatorDashboardPage = require('./CreatorDashboardPage.js');
var ExplorationEditorPage = require('./ExplorationEditorPage.js');
var TopicsAndSkillsDashboardPage = require('./TopicsAndSkillsDashboardPage.js');
var SkillEditorPage = require('./SkillEditorPage');

// Check if the save roles button is clickable.
var canAddRolesToUsers = async function () {
  return await $('.e2e-test-save-role').isEnabled();
};

// Check if exploration is community owned.
var isExplorationCommunityOwned = async function () {
  return await $('.e2e-test-is-community-owned').isExisting();
};

// Check if the warning message is visible when the title is ''.
var checkForAddTitleWarning = async function () {
  return await $('.e2e-test-title-warning').isDisplayed();
};

// Trigger onblur event for title.
var triggerTitleOnBlurEvent = async function () {
  var explorationTitleInput = $('.e2e-test-exploration-title-input');
  await action.click('Exploration Title Input', explorationTitleInput);
  var explorationObjectiveInput = $('.e2e-test-exploration-objective-input');
  await action.click('Exploration Objective Input', explorationObjectiveInput);
};

// Open edit roles.
var openEditRolesForm = async function () {
  var testEditRoles = $('.e2e-test-edit-roles');
  await action.click('Test edit roles', testEditRoles);
  await action.setValue(
    'Test Role Username',
    $('.e2e-test-role-username'),
    'Chuck Norris'
  );
};

// Creates an exploration, opens its editor and skips the tutorial.
var createExploration = async function (welcomeModalIsShown) {
  await createExplorationAndStartTutorial(false);
  var explorationEditorPage = new ExplorationEditorPage.ExplorationEditorPage();
  var explorationEditorMainTab = explorationEditorPage.getMainTab();
  if (welcomeModalIsShown) {
    await explorationEditorMainTab.exitTutorial();
  }
};

// Creates a new exploration and wait for the exploration tutorial to start.
var createExplorationAndStartTutorial = async function (isCollectionEditor) {
  var creatorDashboardPage = new CreatorDashboardPage.CreatorDashboardPage();
  await creatorDashboardPage.get();

  await creatorDashboardPage.clickCreateActivityButton();
  if (isCollectionEditor) {
    var activityCreationModal = $('.e2e-test-creation-modal');
    await waitFor.visibilityOf(
      activityCreationModal,
      'ActivityCreationModal takes too long to be visible.'
    );
    var createExplorationButton = $('.e2e-test-create-exploration');
    await action.click('Create Exploration Button', createExplorationButton);
  }

  await waitFor.pageToFullyLoad();
  var stateNameText = $('.e2e-test-state-name-text');
  await waitFor.visibilityOf(
    stateNameText,
    'State name text takes too long to appear.'
  );
};

/**
 * Only Admin users can create collections.
 */
var createCollectionAsAdmin = async function () {
  var creatorDashboardPage = new CreatorDashboardPage.CreatorDashboardPage();
  await creatorDashboardPage.get();
  await creatorDashboardPage.clickCreateActivityButton();
  var activityCreationModal = $('.e2e-test-creation-modal');
  await waitFor.visibilityOf(
    activityCreationModal,
    'Activity Creation modal takes too long to appear'
  );
  await creatorDashboardPage.clickCreateCollectionButton();
};

/**
 * Creating exploration for Admin users.
 */
var createExplorationAsAdmin = async function () {
  var creatorDashboardPage = new CreatorDashboardPage.CreatorDashboardPage();
  await creatorDashboardPage.get();
  await creatorDashboardPage.clickCreateActivityButton();
  var activityCreationModal = $('.e2e-test-creation-modal');
  await waitFor.visibilityOf(
    activityCreationModal,
    'Activity Creation modal takes too long to appear'
  );
  await creatorDashboardPage.clickCreateExplorationButton();
};

// This will only work if all changes have been saved and there are no
// outstanding warnings; run from the editor.
var publishExploration = async function () {
  var publishButton = $('.e2e-test-publish-exploration');
  var publishButtonMobile = $('.e2e-test-mobile-publish-button');

  let width = (await browser.getWindowSize()).width;
  if (width > 768) {
    await action.click('Test Publish Exploration', publishButton);
  } else {
    var changesOptions = $('.e2e-test-mobile-changes-dropdown');
    await action.click('Changes options', changesOptions);
    await action.click('Publish button mobile', publishButtonMobile);
  }

  var prePublicationButtonElem = $('.e2e-test-confirm-pre-publication');
  await action.click(
    'Pre Publication Button Element',
    prePublicationButtonElem
  );

  await waitFor.invisibilityOf(
    prePublicationButtonElem,
    'prePublicationButtonElem taking too long to disappear while publishing'
  );
  var testConfirmPublish = $('.e2e-test-confirm-publish');
  await action.click('Test Confirm Publish', testConfirmPublish);

  var sharePublishModal = $('.e2e-test-share-publish-modal');
  await waitFor.visibilityOf(
    sharePublishModal,
    'Share Publish Modal takes too long to appear'
  );
  var closePublishModalButton = $('.e2e-test-share-publish-close');
  await action.click('Close Publish Modal Button', closePublishModalButton);
};

// Creates and publishes a minimal exploration.
var createAndPublishExploration = async function (
  title,
  category,
  objective,
  language,
  welcomeModalIsShown
) {
  await createExploration(welcomeModalIsShown);
  var explorationEditorPage = new ExplorationEditorPage.ExplorationEditorPage();
  var explorationEditorMainTab = explorationEditorPage.getMainTab();
  await explorationEditorMainTab.setContent(
    await forms.toRichText('new exploration')
  );
  await explorationEditorMainTab.setInteraction('EndExploration');

  var explorationEditorSettingsTab = explorationEditorPage.getSettingsTab();
  await explorationEditorPage.navigateToSettingsTab();
  await explorationEditorSettingsTab.setTitle(title);
  await explorationEditorSettingsTab.setCategory(category);
  await explorationEditorSettingsTab.setObjective(objective);
  if (language) {
    await explorationEditorSettingsTab.setLanguage(language);
  }
  await explorationEditorPage.saveChanges();
  await publishExploration();
};

var createAddExpDetailsAndPublishExp = async function (
  title,
  category,
  objective,
  language,
  tags,
  welcomeModalIsShown
) {
  await createExploration(welcomeModalIsShown);
  var explorationEditorPage = new ExplorationEditorPage.ExplorationEditorPage();
  var explorationEditorMainTab = explorationEditorPage.getMainTab();
  await explorationEditorMainTab.setContent(
    await forms.toRichText('new exploration')
  );
  await explorationEditorMainTab.setInteraction('EndExploration');
  await explorationEditorPage.saveChanges('Save the changes');
  await explorationEditorPage.publishCardExploration(
    title,
    objective,
    category,
    language,
    tags
  );
};

// Creates and publishes a exploration with two cards.
var createAndPublishTwoCardExploration = async function (
  title,
  category,
  objective,
  language,
  welcomeModalIsShown
) {
  await createExploration(welcomeModalIsShown);
  var explorationEditorPage = new ExplorationEditorPage.ExplorationEditorPage();
  var explorationEditorMainTab = explorationEditorPage.getMainTab();
  await explorationEditorMainTab.setContent(await forms.toRichText('card 1'));
  await explorationEditorMainTab.setInteraction('Continue');
  var responseEditor =
    await explorationEditorMainTab.getResponseEditor('default');
  await responseEditor.setDestination('second card', true, null);
  await explorationEditorMainTab.moveToState('second card');
  await explorationEditorMainTab.setContent(
    await forms.toRichText('card 2'),
    true
  );
  await explorationEditorMainTab.setInteraction('EndExploration');

  var explorationEditorSettingsTab = explorationEditorPage.getSettingsTab();
  await explorationEditorPage.navigateToSettingsTab();
  await explorationEditorSettingsTab.setTitle(title);
  await explorationEditorSettingsTab.setCategory(category);
  await explorationEditorSettingsTab.setObjective(objective);
  if (language) {
    await explorationEditorSettingsTab.setLanguage(language);
  }
  await explorationEditorPage.saveChanges();
  await publishExploration();
};

var createAndPublishExplorationWithAdditionalCheckpoints = async function (
  title,
  category,
  objective,
  language,
  welcomeModalIsShown
) {
  await createExploration(welcomeModalIsShown);
  var explorationEditorPage = new ExplorationEditorPage.ExplorationEditorPage();
  var explorationEditorMainTab = explorationEditorPage.getMainTab();
  await explorationEditorMainTab.setContent(await forms.toRichText('card 1'));
  await explorationEditorMainTab.setInteraction('Continue');
  var responseEditor =
    await explorationEditorMainTab.getResponseEditor('default');
  await responseEditor.setDestination('second card', true, null);
  await explorationEditorMainTab.moveToState('second card');
  await explorationEditorMainTab.setContent(
    await forms.toRichText('card 2'),
    true
  );
  await explorationEditorMainTab.enableCheckpointForCurrentState();
  await explorationEditorMainTab.setInteraction('Continue');
  responseEditor = await explorationEditorMainTab.getResponseEditor('default');
  await responseEditor.setDestination('third card', true, null);
  await explorationEditorMainTab.moveToState('third card');
  await explorationEditorMainTab.setContent(
    await forms.toRichText('card 3'),
    true
  );
  await explorationEditorMainTab.enableCheckpointForCurrentState();
  await explorationEditorMainTab.setInteraction('Continue');
  responseEditor = await explorationEditorMainTab.getResponseEditor('default');
  await responseEditor.setDestination('fourth card', true, null);
  await explorationEditorMainTab.moveToState('fourth card');
  await explorationEditorMainTab.setContent(
    await forms.toRichText('card 4'),
    true
  );
  await explorationEditorMainTab.setInteraction('EndExploration');

  var explorationEditorSettingsTab = explorationEditorPage.getSettingsTab();
  await explorationEditorPage.navigateToSettingsTab();
  await explorationEditorSettingsTab.setTitle(title);
  await explorationEditorSettingsTab.setCategory(category);
  await explorationEditorSettingsTab.setObjective(objective);
  if (language) {
    await explorationEditorSettingsTab.setLanguage(language);
  }
  await explorationEditorPage.saveChanges();
  await publishExploration();
};

// ---- Role management (state editor settings tab) ----

// Here, 'roleName' is the user-visible form of the role name (e.g. 'Manager').
var _addExplorationRole = async function (roleName, username) {
  await action.click('Edit roles', $('.e2e-test-edit-roles'));
  var usernameInput = $('.e2e-test-role-username');
  await waitFor.visibilityOf(
    usernameInput,
    'Username input is not visible after clicking Edit roles'
  );
  await action.setValue('Username input', usernameInput, username);
  await action.matSelect('Role select', $('.e2e-test-role-select'), roleName);
  await action.click('Save role', $('.e2e-test-save-role'));
};

var addExplorationManager = async function (username) {
  await _addExplorationRole('Manager (can edit permissions)', username);
};

var addExplorationCollaborator = async function (username) {
  await _addExplorationRole('Collaborator (can make changes)', username);
};

var addExplorationVoiceArtist = async function (username) {
  await action.click(
    'Edit voice artist role button',
    $('.e2e-test-edit-voice-artist-roles')
  );
  await action.setValue(
    'New voice artist username input',
    $('.e2e-test-new-voice-artist-username'),
    username
  );
  await action.click(
    'Add voice artist button',
    $('.e2e-test-add-voice-artist-role-button')
  );
  await waitFor.visibilityOf($('.e2e-test-voice-artist-' + username));
};

var addExplorationPlaytester = async function (username) {
  await _addExplorationRole('Playtester', username);
};

// Here, roleName is the server-side form of the name (e.g. 'owner').
var _getExplorationRoles = async function (roleName, isEmpty) {
  var explorationRoleNameLocator = '.e2e-test-' + roleName + '-role-names';
  if (!isEmpty) {
    await waitFor.visibilityOf(
      $(explorationRoleNameLocator),
      `Exploration ${roleName} name is not visible`
    );
  }
  return await $$(explorationRoleNameLocator).map(async function (elem) {
    return await elem.getText();
  });
};

var getExplorationManagers = async function (isEmpty = false) {
  return await _getExplorationRoles('owner', isEmpty);
};

var getExplorationCollaborators = async function (isEmpty = false) {
  return await _getExplorationRoles('editor', isEmpty);
};

var getExplorationVoiceArtists = async function (isEmpty = false) {
  return await _getExplorationRoles('voiceArtist', isEmpty);
};

var getExplorationPlaytesters = async function (isEmpty = false) {
  return await _getExplorationRoles('viewer', isEmpty);
};

var createTopic = async function (
  topicName,
  topicUrlFragment,
  description,
  shouldCloseTopicEditor
) {
  var topicsAndSkillsDashboardPage =
    new TopicsAndSkillsDashboardPage.TopicsAndSkillsDashboardPage();
  await topicsAndSkillsDashboardPage.get();
  await topicsAndSkillsDashboardPage.createTopic(
    topicName,
    topicUrlFragment,
    description,
    shouldCloseTopicEditor
  );
};

var createSkillAndAssignTopic = async function (
  skillDescription,
  material,
  topicName
) {
  var topicsAndSkillsDashboardPage =
    new TopicsAndSkillsDashboardPage.TopicsAndSkillsDashboardPage();
  await topicsAndSkillsDashboardPage.get();
  await topicsAndSkillsDashboardPage.createSkillWithDescriptionAndExplanation(
    skillDescription,
    material,
    true
  );
  await topicsAndSkillsDashboardPage.get();
  await topicsAndSkillsDashboardPage.navigateToSkillsTab();
  await topicsAndSkillsDashboardPage.filterSkillsByStatus('Unassigned');
  await topicsAndSkillsDashboardPage.assignSkillToTopic(
    skillDescription,
    topicName
  );
};

var getImageSource = async function (customImageElement) {
  await waitFor.visibilityOf(
    customImageElement,
    'Image element is taking too long to appear.'
  );
  return await customImageElement.getAttribute('src');
};

var uploadImage = async function (
  imageClickableElement,
  imgPath,
  resetExistingImage
) {
  await action.click('Image clickable element', imageClickableElement);
  var thumbnailResetButton = $('.e2e-test-thumbnail-reset-button');
  if (resetExistingImage) {
    expect(await thumbnailResetButton.isExisting()).toBe(true);
    await action.click('Topic thumbnail reset button', thumbnailResetButton);
  } else {
    expect(await thumbnailResetButton.isExisting()).toBe(false);
  }

  absPath = path.resolve(__dirname, imgPath);
  var imageUploadInput = $('.e2e-test-photo-upload-input');
  return await action.setValue(
    'Image Upload Input',
    imageUploadInput,
    absPath,
    (clickInputElement = false)
  );
};

var submitImage = async function (
  imageClickableElement,
  imageContainer,
  imgPath,
  resetExistingImage
) {
  await waitFor.visibilityOf(
    imageClickableElement,
    'Image element is taking too long to appear.'
  );
  await uploadImage(imageClickableElement, imgPath, resetExistingImage);
  await waitFor.visibilityOf(
    imageContainer,
    'Image container is taking too long to appear'
  );
  var imageSubmitButton = $('.e2e-test-photo-upload-submit');
  await action.click('Image submit button', imageSubmitButton);
  var imageUploadInput = $('.e2e-test-photo-upload-input');
  await waitFor.invisibilityOf(
    imageUploadInput,
    'Image uploader is taking too long to disappear'
  );
  await waitFor.invisibilityOf(
    imageContainer,
    'Image container is taking too long to disappear'
  );
  return await waitFor.pageToFullyLoad();
};

var createQuestion = async function () {
  var skillEditorPage = new SkillEditorPage.SkillEditorPage();
  var explorationEditorPage = new ExplorationEditorPage.ExplorationEditorPage();
  var explorationEditorMainTab = explorationEditorPage.getMainTab();
  await skillEditorPage.moveToQuestionsTab();
  await skillEditorPage.clickCreateQuestionButton();
  await explorationEditorMainTab.setContent(
    await forms.toRichText('Question 1'),
    true
  );
  await explorationEditorMainTab.setInteraction('TextInput', 'Placeholder', 5);
  await explorationEditorMainTab.addResponse(
    'TextInput',
    await forms.toRichText('Correct Answer'),
    null,
    false,
    'FuzzyEquals',
    ['correct']
  );
  var responseEditor = await explorationEditorMainTab.getResponseEditor(0);
  await responseEditor.markAsCorrect();
  await (
    await explorationEditorMainTab.getResponseEditor('default')
  ).setFeedback(await forms.toRichText('Try again'));
  await explorationEditorMainTab.addHint('Hint 1');
  await explorationEditorMainTab.addSolution('TextInput', {
    correctAnswer: 'correct',
    explanation: 'It is correct',
  });
  await skillEditorPage.saveQuestion();
};

// Sets the question interaction to NumericInput after deleting the
// existing interaction.
var changeQuestionInteraction = async function () {
  var explorationEditorPage = new ExplorationEditorPage.ExplorationEditorPage();
  var explorationEditorMainTab = explorationEditorPage.getMainTab();
  await explorationEditorMainTab.deleteInteraction();
  await explorationEditorMainTab.setInteraction('NumericInput');
  await explorationEditorMainTab.addResponse(
    'NumericInput',
    await forms.toRichText('Correct Answer'),
    null,
    false,
    'IsGreaterThan',
    2
  );
  await (await explorationEditorMainTab.getResponseEditor(0)).markAsCorrect();
  await (
    await explorationEditorMainTab.getResponseEditor('default')
  ).setFeedback(await forms.toRichText('Try again'));
  await explorationEditorMainTab.addHint('Hint 1');
  await explorationEditorMainTab.addSolution('NumericInput', {
    correctAnswer: 4,
    explanation: 'It is correct',
  });
};

exports.getImageSource = getImageSource;
exports.submitImage = submitImage;
exports.uploadImage = uploadImage;

exports.createExploration = createExploration;
exports.createExplorationAndStartTutorial = createExplorationAndStartTutorial;
exports.publishExploration = publishExploration;
exports.createAndPublishExploration = createAndPublishExploration;
exports.createCollectionAsAdmin = createCollectionAsAdmin;
exports.createExplorationAsAdmin = createExplorationAsAdmin;
exports.createAndPublishTwoCardExploration = createAndPublishTwoCardExploration;
exports.createAndPublishExplorationWithAdditionalCheckpoints =
  createAndPublishExplorationWithAdditionalCheckpoints;

exports.canAddRolesToUsers = canAddRolesToUsers;
exports.isExplorationCommunityOwned = isExplorationCommunityOwned;
exports.checkForAddTitleWarning = checkForAddTitleWarning;
exports.triggerTitleOnBlurEvent = triggerTitleOnBlurEvent;
exports.openEditRolesForm = openEditRolesForm;
exports.addExplorationManager = addExplorationManager;
exports.addExplorationCollaborator = addExplorationCollaborator;
exports.addExplorationVoiceArtist = addExplorationVoiceArtist;
exports.addExplorationPlaytester = addExplorationPlaytester;
exports.getExplorationManagers = getExplorationManagers;
exports.getExplorationCollaborators = getExplorationCollaborators;
exports.getExplorationVoiceArtists = getExplorationVoiceArtists;
exports.getExplorationPlaytesters = getExplorationPlaytesters;
exports.createAddExpDetailsAndPublishExp = createAddExpDetailsAndPublishExp;
exports.createTopic = createTopic;
exports.createSkillAndAssignTopic = createSkillAndAssignTopic;
exports.createQuestion = createQuestion;
exports.changeQuestionInteraction = changeQuestionInteraction;