upstream-mattermost/e2e-tests/cypress/tests/integration/channels/slash_commands/autocomplete_spec.js

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

// ***************************************************************
// - [#] indicates a test step (e.g. # Go to a page)
// - [*] indicates an assertion (e.g. * Check the title)
// - Use element ID when selecting an element. Create one if none.
// ***************************************************************

// Group: @channels @not_cloud @integrations @plugin

import {demoPlugin, jiraPlugin} from '@/utils/plugins';

describe('Integrations', () => {
    before(() => {
        cy.shouldNotRunOnCloudEdition();
        cy.shouldHavePluginUploadEnabled();

        cy.apiUploadAndEnablePlugin(demoPlugin);
        cy.apiUploadAndEnablePlugin(jiraPlugin);

        // # Initialize setup and visit town-square
        cy.apiInitSetup().then(({team}) => {
            cy.visit(`/${team.name}/channels/town-square`);
        });
    });

    it('MM-T2829 Test an example of plugin that uses sub commands', () => {
        // # Post a slash command with trailing space
        cy.uiGetPostTextBox().clear().type('/jira ');

        // * Verify suggestion list is visible and includes 'info'
        cy.get('#suggestionList').findByText('info').scrollIntoView().should('be.visible');

        // # Narrow down list to show info only suggestion
        cy.uiGetPostTextBox().type('inf');

        // * Verify suggestion list is visible with only 1 child
        cy.get('#suggestionList').should('be.visible').children().should('have.length', 1);

        // * Verify list is refined to only the info sub command
        cy.get('#suggestionList').findByText('info').should('be.visible');

        // # click the info subcommand and hit enter
        cy.get('#suggestionList').findByText('info').should('be.visible').click();
        cy.uiGetPostTextBox().type('{enter}');

        // * Verify message is sent and (only visible to you)
        cy.getLastPostId().then((postId) => {
            cy.get(`#post_${postId}`).
                should('contain.text', '(Only visible to you)').
                should('contain.text', 'is not a valid Mattermost SITEURL.');
        });
    });

    it('MM-T2830 Test an example of a plugin using static list', () => {
        // # Post a slash command with trailing space
        cy.uiGetPostTextBox().clear().type('/jira ');

        // * Verify suggestion includes instance subcommand and is visible
        cy.get('#suggestionList').should('contain.text', 'instance').scrollIntoView().should('be.visible');

        // # Narrow down list to show info only suggestion
        cy.uiGetPostTextBox().type('i');

        // * Verify suggestion list is visible with three children (issue, instance, info)
        cy.get('#suggestionList').should('be.visible').children().
            should('contain.text', 'issue').
            should('contain.text', 'instance').
            should('contain.text', 'info');

        // # Clear test and post a slash command with trailing space
        cy.uiGetPostTextBox().clear().type('/jira instance settings ');

        // * Verify suggestion notifications is visible
        cy.get('#suggestionList').should('contain.text', 'notifications').scrollIntoView().should('be.visible');

        // # Clear test and Post a slash command with trailing space
        cy.uiGetPostTextBox().type('notifications ');

        // * Verify notifications suggestion is visible and lists on/off options
        cy.get('#suggestionList').should('be.visible').children().
            should('contain.text', 'on').
            should('contain.text', 'off');

        // # down arrow to highlight the second suggestion
        // # enter to push to send command to post textbox
        cy.uiGetPostTextBox().type('{downarrow}{downarrow}{enter}');

        // # Send the command
        cy.uiGetPostTextBox().type('{enter}');

        // * Verify message is sent and (only visible to you)
        cy.getLastPostId().then((postId) => {
            cy.get(`#post_${postId}`).
                should('contain.text', '(Only visible to you)').
                should('contain.text', 'is not a valid Mattermost SITEURL.');
        });
    });

    it('MM-T2831 Test an example of plugin using dynamic list', () => {
        // # Post a slash command with trailing space
        cy.uiGetPostTextBox().clear().type('/autocomplete_test dynamic-arg ');

        // * Verify suggestion list is visible with at three children (issue, instance, info)
        cy.get('#suggestionList').should('be.visible').children().
            should('contain.text', 'suggestion 1 (hint)').
            should('contain.text', 'suggestion 2 (hint)');

        // # down arrow to highlight the second suggestion
        // # enter to push to send command to post textbox
        cy.uiGetPostTextBox().type('{downarrow}{downarrow}{enter}');

        // # Send the command
        cy.uiGetPostTextBox().type('{enter}');

        // * Verify correct message is sent,  (only visible to you)
        cy.getLastPostId().then((postId) => {
            cy.get(`#post_${postId}`).
                should('contain.text', '(Only visible to you)').
                should('contain.text', 'Executed command: /autocomplete_test dynamic-arg suggestion 2');
        });
    });

    it('MM-T2832 Use a slash command that omits the optional argument', () => {
        // # Post a slash command that omits the optional argument
        cy.uiGetPostTextBox().clear().type('/autocomplete_test optional-arg {enter}');

        // * Verify item is sent and is (only visible to you)
        cy.getLastPostId().then((postId) => {
            cy.get(`#post_${postId}`).contains('Executed command: /autocomplete_test optional-arg');
        });
    });

    it('MM-T2833 Use a slash command that accepts an optional argument', () => {
        // # Post a slash command that accepts an optional argument
        cy.uiGetPostTextBox().clear().type('/autocomplete_test optional-arg --name1 testarg {enter}');

        // * Verify item is sent and is (only visible to you)
        cy.getLastPostId().then((postId) => {
            cy.get(`#post_${postId}`).contains('Executed command: /autocomplete_test optional-arg --name1 testarg');
        });
    });

    it('MM-T2834 Slash command help stays visible for system slash command', () => {
        // # Post a slash command without trailing space
        cy.uiGetPostTextBox().type('/rename');

        // * Verify suggestion list is visible with only 1 child
        cy.get('#suggestionList').should('be.visible').children().should('have.length', 1);

        // * Verify suggestion list is visible
        cy.get('#suggestionList').children().eq(0).findByText('Rename the channel').should('be.visible');

        // # Add trailing space to '/rename' command
        cy.uiGetPostTextBox().type(' ');

        // * Verify command text is no longer visible after space is added
        cy.findByText('Rename the channel').should('not.exist');

        // * Verify suggestion list is visible with 2 children
        cy.get('#suggestionList').should('be.visible').children().should('have.length', 2);

        // * Verify execute current command text shows in first element
        cy.get('#suggestionList').children().eq(0).findByText('Execute Current Command').should('be.visible');

        // * After typing the space character the relevant tip is still displayed
        cy.get('.slash-command__desc').contains('[text]').should('be.visible');
    });

    it('MM-T2835 Slash command help stays visible for plugin', () => {
        // # Post a slash command with trailing space
        cy.uiGetPostTextBox().clear().type('/jira ');

        // * Verify suggestion list is visible with 11 children
        cy.get('#suggestionList').should('be.visible').children().should('have.length', 11);
    });
});