English | [简体中文](../../zh/test/3-1-E2E-form-operation.md)

Because of the consistency of the front-end framework, when we write related use cases for form operations, select elements and operate, we often find that there is a strong regularity, so we have written corresponding Cypress functions for most of the form operations. It greatly reduces the difficulty of writing test cases. The following will give a detailed description of the main form operation functions.

> Note: The functions written are based on the principle that the operation of a form item can be completed completely

## Click the button operation

- `closeNotice`
  - Close the prompt message of successful operation in the upper right corner

  ![notice](images/e2e/form/notice.png)

- `waitFormLoading`
  - Wait for the form request to complete
  - After the form is filled in and verified, click the confirm  button to initiate a corresponding request to the server. At this time, the confirm  button of the form item will be in the state of `Loading`
  - Using this function, instead of `cy.wait(seconds)`, can more effectively ensure that the synchronization request has been processed completely, thereby ensuring the prerequisites for subsequent use cases

  ![wait-form-loading](images/e2e/form/wait-form-loading.png)

- `clickFormActionSubmitButton`
  - Click the confirm button of the confirm  form and wait for the request to complete

  ![click-form-submit](images/e2e/form/click-form-submit.png)

- `clickModalActionSubmitButton`
  - Click the confirma button in the pop-up form and wait for the request to complete

  ![click-modal-submit](images/e2e/form/click-modal-submit.png)

- `clickModalActionCancelButton`
  - Click the cancel button of the pop-up form
- `clickConfirmActionSubmitButton`
  - Click the confirmation button of the confirmation form, wait for the request to complete, and close the prompt message that the request is successful
  - Parameter `waitTime`, the waiting time after closing the prompt message

  ![click-confirm-submit](images/e2e/form/click-confirm-submit.png)

- `checkDisableAction`
  - If some data does not meet the requirements, an error will pop up when using batch operations. This function verifies that the data does not meet the operation requirements, and closes the error prompt
  - Take the locked instance as an example: `test/e2e/integration/pages/compute/instance.spec.js`
    - After locking, it no longer supports startup, shutdown, and restart operations

    ```javascript
    it('successfully lock', () => {
      cy.tableSearchText(name)
        .clickConfirmActionInMoreSub('Lock', 'Instance Status')
        .wait(10000);
      cy.tableSearchText(name)
        .selectFirst()
        .clickHeaderButtonByTitle('Start')
        .checkDisableAction(2000)
        .clickHeaderButtonByTitle('Stop')
        .checkDisableAction(2000)
        .clickHeaderButtonByTitle('Reboot')
        .checkDisableAction(2000);
    });
    ```

    ![disable-action](images/e2e/form/disable-action.png)

- `clickStepActionNextButton`
  - Click the Next/Confirm button of the step-by-step form
  - Take the create instance use case as an example: `test/e2e/integration/pages/compute/instance.spec.js`
    - A total of 3 clicks on the next step and 1 confirmation button

    ```javascript
    it('successfully create', () => {
      cy.clickHeaderButton(1)
        .url()
        .should('include', `${listUrl}/create`)
        .wait(5000)
        .formTableSelect('flavor')
        .formTableSelect('image')
        .formSelect('systemDisk')
        .formAddSelectAdd('dataDisk')
        .formSelect('dataDisk')
        .wait(2000)
        .clickStepActionNextButton()
        .wait(5000)
        .formTableSelectBySearch('networkSelect', networkName, 5000)
        .formTableSelectBySearch('securityGroup', 'default', 5000)
        .wait(2000)
        .clickStepActionNextButton()
        .formInput('name', name)
        .formRadioChoose('loginType', 1)
        .formInput('password', password)
        .formInput('confirmPassword', password)
        .wait(2000)
        .clickStepActionNextButton()
        .wait(2000)
        .clickStepActionNextButton()
        .waitFormLoading()
        .url()
        .should('include', listUrl)
        .closeNotice()
        .waitStatusActiveByRefresh();
    });
    ```

    ![click-step-next](images/e2e/form/click-step-next.png)

- `clickStepActionCancelButton`
  - Click the cancel button of the step-by-step form
  - Take image create instance `test/e2e/integration/pages/compute/image.spec.js`as example
    - Only verify that you can successfully enter the create instancepage, and then click the cancel button to complete the use case

    ```javascript
    it('successfully create instance with cancel', () => {
      cy.tableSearchText(name)
        .clickActionInMore('Create Instance')
        .wait(2000)
        .clickStepActionCancelButton();
    });
    ```

## Operations on form

Looking at the structure and style of the elements through the page, I found that all form items have an id, And corresponding to the `name` property of the form configuration `formItem` written during development, the `name` can also be obtained directly by viewing the `id` of the element in the page, as shown in the following figure, after the `form-item-col-` The content is `name`

![form-name](images/e2e/form/form-name.png)

- `formInput`
  - Input content of form items with `input` input box
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Parameter `value`，enter value
  - Take instance use case`test/e2e/integration/pages/compute/instance.spec.js` as an Example

    ```javascript
    it('successfully edit', () => {
      cy.tableSearchText(name)
        .clickActionInMore('Edit')
        .formInput('name', newname)
        .clickModalActionSubmitButton()
        .wait(2000);
    });
    ```

    ![input](images/e2e/form/input.png)

- `formJsonInput`
  - The form with the `textarea` input box enters the `json` format content
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Parameter `content`, the input object
  - Take create stack and write the parameter `test/e2e/integration/pages/heat/stack.spec.js` of type `json` as an example

    ```javascript
    it('successfully create', () => {
      const volumeJson = {
        name: volumeName,
      };
      cy.clickHeaderButton(1, 2000)
        .formAttachFile('content', contentFile)
        .formAttachFile('params', paramFile)
        .clickStepActionNextButton()
        .wait(2000)
        .formInput('name', name)
        .formJsonInput('volume_name_spec', volumeJson)
        .clickStepActionNextButton()
        .waitFormLoading()
        .wait(5000)
        .tableSearchSelectText('Name', name)
        .waitStatusActiveByRefresh();
    });
    ```

    ![textarea-json](images/e2e/form/textarea-json.png)

- `formCheckboxClick`
  - check `checkbox` in form
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Parameter `index`, default `0`
  - Take instance resize `test/e2e/integration/pages/compute/instance.spec.js` as an enample

    ```javascript
    it('successfully resize', () => {
      cy.tableSearchText(name)
        .clickActionInMoreSub('Resize', 'Configuration Update')
        .wait(5000)
        .formTableSelect('newFlavor')
        .formCheckboxClick('option')
        .clickModalActionSubmitButton()
        .waitStatusActiveByRefresh();
    });
    ```

    ![checkbox](images/e2e/form/checkbox.png)

- `formTableSelectAll`
  - Click Select all checkbox of the selection type form select all item
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Take cloud hard disk type modification to access `test/e2e/integration/pages/storage/volume-type.spec.js` as an example

    ```javascript
    it('successfully manage access to projects', () => {
      cy.tableSearchText(name)
        .clickActionInMore('Manage Access')
        .formCheckboxClick('isPublic')
        .formTableSelectAll('access')
        .clickModalActionSubmitButton();
    });
    ```

    ![select-all](images/e2e/form/select-all.png)

- `formTableNotSelectAll`
  - Click Select all checkbox of the selection type form cancel select all item
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Take the Host Aggregates management instance without selecting the instance as an example: `test/e2e/integration/pages/compute/aggregate.spec.js`

    ```javascript
    it('successfully manage host: no host', () => {
      cy.tableSearchText(newname)
        .clickActionInMore('Manage Host')
        .formTableNotSelectAll('hosts')
        .clickModalActionSubmitButton();
    });
    ```

    ![unselect-all](images/e2e/form/unselect-all.png)

- `formTableSelect`
  - Click checkbox of the selection type form
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Parameter `value`, if you set `value`, select the entry in the table that contains the value, if you don’t set `value`, select the first entry in the table
  - Take instance attach interface select network`test/e2e/integration/pages/compute/instance.spec.js`as an example

    ```javascript
    it('successfully attach interface', () => {
      cy.tableSearchText(name)
        .clickActionInMoreSub('Attach Interface', 'Related Resources')
        .wait(5000)
        .formTableSelect('network')
        .clickModalActionSubmitButton();
    });
    ```

    ![select-table](images/e2e/form/select-table.png)

- `formTableSelectBySearch`
  - For the selection type form, first to search operation, and then select the first item in the table
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Parameter `value`, search content, generally a search for `name` in the search term
  - Parameter `waitTime`, wait time after searching, default wait 2 seconds
  - Take instance attach volume select volume `test/e2e/integration/pages/compute/instance.spec.js` as an example

    - After the operation is successful, enter the Volume list page to check the status of the volume as "used"

    ```javascript
    it('successfully attach volume', () => {
      // prepair volume
      cy.visitPage(listUrl)
        .tableSearchText(name)
        .clickActionInMoreSub('Attach Volume', 'Related Resources')
        .wait(5000)
        .formTableSelectBySearch('volume', volumeName)
        .clickModalActionSubmitButton()
        .wait(5000);

      // check attach successful
      cy.tableSearchText(name)
        .goToDetail()
        .clickDetailTab('Volume')
        .tableSearchText(volumeName)
        .checkColumnValue(2, 'In-use');
    });
    ```

    ![select-table-search](images/e2e/form/select-table-search.png)

- `formTableSelectBySearchOption`
  - For the selection type form, first to search operation, and then select the first item in the table
  - Search is the selection of search item, which is different from `formTableSelectBySearch` which is based on input
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Parameter `name`， Search options name
  - Parameter `value`Search options value
  - Parameter `waitTime`，wait time after searching, default wait 2 seconds
  - Take create full backup `test/e2e/integration/pages/storage/backup.spec.js` as an example
    - Select Volume that status is in used

    ```javascript
    it('successfully create full bakcup', () => {
      cy.clickHeaderButton(1, 5000)
        .formInput('name', name)
        .formTableSelectBySearch('volume', volumeName)
        .clickModalActionSubmitButton()
        .wait(5000)
        .waitTableLoading();

      cy.clickHeaderButton(1, 5000)
        .formInput('name', nameIns)
        .formTableSelectBySearchOption('volume', 'Status', 'In-use')
        .clickModalActionSubmitButton();

      cy.wait(30000);
    });
    ```

    ![select-table-option](images/e2e/form/select-table-option.png)

- `formSelect`
  - Operations on form items of selector type
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Parameter `label`, the selected content, if not set, select the first option, if set, select the option corresponding to `label`
  - Take create instance group select policy `test/e2e/integration/pages/compute/server-group.spec.js`as an example

    ```javascript
    it('successfully create', () => {
      cy.clickHeaderButton(1)
        .formInput('name', name)
        .formSelect('policy')
        .clickModalActionSubmitButton();
    });
    ```

    ![select](images/e2e/form/select.png)

  - Take the network QoS policy to create the bandwidth limit rule and set the direction to "inbound" as an example: `test/e2e/integration/pages/network/qos-policy.spec.js`

    ```javascript
    it('successfully create bandwidth ingress limit rule', () => {
      cy.tableSearchText(name)
        .clickActionInMore('Create Bandwidth Limit Rule')
        .formSelect('direction', 'ingress')
        .clickModalActionSubmitButton();
    });
    ```

    ![select-value](images/e2e/form/select-value.png)

- `formRadioChoose`
  - Operations on form items of radio type
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Parameter `itemIndex`, which item is selected, the default is 0, that is, the first item is selected
  - Take create a key, select "import key" `test/e2e/integration/pages/compute/keypair.spec.js` as an example

    ```javascript
    it('successfully create by file', () => {
      cy.clickHeaderButton(1)
        .formRadioChoose('type', 1)
        .formInput('name', nameByFile)
        .formAttachFile('public_key', filename)
        .clickModalActionSubmitButton()
        .tableSearchText(nameByFile)
        .checkTableFirstRow(nameByFile);
    });
    ```

    ![radio](images/e2e/form/radio.png)

- `formAttachFile`
  - Operations on form items of AttachFile type
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - The parameter `filename`, the name of the uploaded file, the file needs to be saved in the `test/e2e/fixtures` directory in advance
  - Take the creation of a key selection file as an example as an example: `test/e2e/integration/pages/compute/keypair.spec.js`

    ```javascript
    it('successfully create by file', () => {
      cy.clickHeaderButton(1)
        .formRadioChoose('type', 1)
        .formInput('name', nameByFile)
        .formAttachFile('public_key', filename)
        .clickModalActionSubmitButton()
        .tableSearchText(nameByFile)
        .checkTableFirstRow(nameByFile);
    });
    ```

    ![attach-file](images/e2e/form/attach-file.png)

  - Take create image select file `test/e2e/integration/pages/compute/image.spec.js` as an example

    ```javascript
    it('successfully create', () => {
      cy.clickHeaderButton(1)
        .url()
        .should('include', `${listUrl}/create`)
        .formInput('name', name)
        .formAttachFile('file', filename)
        .formSelect('disk_format', 'QCOW2 - QEMU Emulator')
        .formSelect('os_distro', 'Others')
        .formInput('os_version', 'cirros-0.4.0-x86_64')
        .formInput('os_admin_user', 'root')
        .formSelect('usage_type', 'Common Server')
        .formText('description', name)
        .clickFormActionSubmitButton()
        .wait(2000)
        .url()
        .should('include', listUrl)
        .tableSearchText(name)
        .waitStatusActiveByRefresh();
    });
    ```

    ![attach-file-image](images/e2e/form/attach-file-image.png)

- `formAddSelectAdd`
  - Operations on form item of AddSelect type
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Take the Host Aggregates management metedata add custom metadata as an example: `test/e2e/integration/pages/compute/aggregate.spec.js`

    ```javascript
    it('successfully manage metadata', () => {
      cy.tableSearchText(name)
        .clickActionInMore('Manage Metadata')
        .wait(5000)
        .formAddSelectAdd('customs')
        .formInputKeyValue('customs', 'key', 'value')
        .formTransferLeftCheck('systems', 0)
        .clickModalActionSubmitButton();
    });
    ```

    ![add-select](images/e2e/form/add-select.png)

- `formSwitch`
  - Operations on form item of swith type
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Take the example of creating a network QoS policy `test/e2e/integration/pages/network/qos-policy.spec.js` with shared attributes

    ```javascript
    it('successfully create', () => {
      cy.clickHeaderButton(1)
        .wait(2000)
        .formInput('name', name)
        .formText('description', name)
        .formSwitch('shared')
        .clickModalActionSubmitButton();
    });
    ```

    ![switch](images/e2e/form/switch.png)

- `formButtonClick`
  - Click button on form
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Take the example of expanding/closing the "advanced option" `test/e2e/integration/pages/identity/project.spec.js` when the project update quota

    ```javascript
    it('successfully edit quota', () => {
      cy.tableSearchText(name)
        .clickActionInMore('Edit Quota')
        .formInput('instances', 11)
        .formButtonClick('more')
        .wait(2000)
        .formButtonClick('more')
        .clickModalActionSubmitButton();
    });
    ```

    ![more](images/e2e/form/more.png)

    ![more-open](images/e2e/form/more-open.png)

- `formTransfer`
  - Operation on form item of transfer type
    1. Specify the items to be selected based on the search display in the transfer on the left
    2. Select the first item
    3. Click the direction button in the middle of the transfer to make the selected content enter the transfer on the right
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Parameter `value`, search content
  - Take peoject management user `test/e2e/integration/pages/identity/project.spec.js`as an example

    ```javascript
    it('successfully manage user', () => {
      cy.tableSearchText(name)
        .clickActionInMore('Manage User')
        .formTransfer('select_user', username)
        .formTransferRight('select_user', username)
        .formSelect('select_user', 'admin')
        .clickModalActionSubmitButton();
    });
    ```

    ![transfer-left](images/e2e/form/transfer-left.png)

- `formTransferRight`
  - Specify the items to be selected based on the search display in the transfer on the right对右侧的穿梭框基于搜索展示指定待选条目
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Parameter `value`, search content
  - Take the user group management user as an example: `test/e2e/integration/pages/identity/user-group.spec.js`

    ```javascript
    it('successfully manage user', () => {
      cy.tableSearchText(name)
        .clickActionInMore('Manage User')
        .formTransfer('select_user', username)
        .formTransferRight('select_user', username)
        .clickModalActionSubmitButton();

      cy.tableSearchText(name)
        .goToDetail()
        .clickDetailTab('Sub User', 'userGroup');
    });
    ```

    ![transfer-right](images/e2e/form/transfer-right.png)

- `formTabClick`
  - Click tab in the form item with tab
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - The parameter `index`, the subscript of the specified Tab
  - Take the example of editing the floating IP and switching to the sharing strategy `test/e2e/integration/pages/network/floatingip.spec.js`

    ```javascript
    it('successfully edit', () => {
      cy.clickFirstActionButton()
        .formText('description', 'description')
        .formTabClick('qos_policy_id', 1)
        .wait(5000)
        .formTableSelectBySearch('qos_policy_id', policyName)
        .clickModalActionSubmitButton()
        .wait(2000);
    });
    ```

    ![tab](images/e2e/form/tab.png)

- `formInputKeyValue`
  - Input operations on the form items of the `KeyValue` component, generally used in conjunction with `formAddSelectAdd`, and enter the content of the item of the added new `KeyValue` component
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Parameter `key`, the content of input on the left
  - Parameter `value`, the content of input on the right
  - Take the Host Aggregates management metedata add custom metadata as an example: `test/e2e/integration/pages/compute/aggregate.spec.js`

    ```javascript
    it('successfully manage metadata', () => {
      cy.tableSearchText(name)
        .clickActionInMore('Manage Metadata')
        .wait(5000)
        .formAddSelectAdd('customs')
        .formInputKeyValue('customs', 'key', 'value')
        .formTransferLeftCheck('systems', 0)
        .clickModalActionSubmitButton();
    });
    ```

    ![key-value](images/e2e/form/key-value.png)

- `formTransferLeftCheck`
  - Operation of the transfer on the left
    1. Select the specified item in the transfer on the left
    2. Click the direction button in the middle of the transfer to make the selected content enter the transfer on the right
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Parameter `index`, the index of the node
  - Take the Host Aggregates management metedata add custom metadata as an example: `test/e2e/integration/pages/compute/aggregate.spec.js`

    ```javascript
    it('successfully manage metadata', () => {
      cy.tableSearchText(name)
        .clickActionInMore('Manage Metadata')
        .wait(5000)
        .formAddSelectAdd('customs')
        .formInputKeyValue('customs', 'key', 'value')
        .formTransferLeftCheck('systems', 0)
        .clickModalActionSubmitButton();
    });
    ```

    ![transfer-left-click](images/e2e/form/transfer-left-click.png)

- `formTransferRightCheck`
  - Operation of the transfer on the rigth
    1. Select the specified item in the transfer on the rigth
    2. Click the direction button in the middle of the transfer to make the selected content enter the transfer on the left
  - Parameter `formItemName`, which is the `name` value of `formItem` in the development code
  - Parameter `index`, the index of the transfer table item
  - Take instance type modify the metadata `test/e2e/integration/pages/compute/flavor.spec.js` as an example

    ```javascript
    it('successfully manage metadata', () => {
      cy.clickTab('Custom')
        .tableSearchText(customName)
        .clickActionButtonByTitle('Manage Metadata')
        .wait(5000)
        .formTransferLeftCheck('systems', 0)
        .clickModalActionSubmitButton();

      // todo: remove key-value metadata
      cy.clickTab('Custom')
        .tableSearchText(customName)
        .clickActionButtonByTitle('Manage Metadata')
        .wait(5000)
        .formTransferRightCheck('systems', 0)
        .clickModalActionSubmitButton();
    });
    ```

    ![transfer-right-check](images/e2e/form/transfer-right-check.png)

For various operations of resource operations, the functions introduced above are mainly used. For the specific compilation of functions, please see`test/e2e/support/form-commands.js`
