Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: Added drawer extension e2e tests (Issue/3470) #3471

Closed
wants to merge 3 commits into from
Closed

Chore: Added drawer extension e2e tests (Issue/3470) #3471

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a6a2217
Added initial drawer tests
lemmyadams Oct 6, 2023
b7e4632
View button more specific
lemmyadams Oct 6, 2023
a6acf9b
type
lemmyadams Oct 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions test/e2e/extensions/drawer.cy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
import Course from '../../../src/course/en/course.json'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting... very interesting...

The tests can be run against a specified build output folder, which wouldn't have a src/course but an {outputdir}/{coursedir}/ instead. So we're going to need some way of grabbing that stuff in the test runtime such that the json can be loaded from the correct place.

Copy link
Member

@oliverfoster oliverfoster Oct 6, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adapt_framework/grunt/helpers.js

Lines 150 to 152 in 0da0411

sourcedir: 'src/',
outputdir: 'build/',
coursedir: 'course',

adapt_framework/grunt/helpers.js

Lines 201 to 218 in 0da0411

const outputdir = appendSlash(grunt.option('outputdir')) || exports.defaults.outputdir;
const cachepath = grunt.option('cachepath') || null;
const tempdir = outputdir + '.temp/';
const jsonext = grunt.option('jsonext') || exports.defaults.jsonext;
const coursedir = grunt.option('coursedir') || adaptJSON.coursedir || exports.defaults.coursedir;
let languageFolders = '';
if (grunt.option('languages') && grunt.option('languages').split(',').length > 1) {
languageFolders = '{' + grunt.option('languages') + '}';
} else {
languageFolders = grunt.option('languages');
}
// Selectively load the course.json ('outputdir' passed by server-build)
const configDir = grunt.option('outputdir') ? outputdir : sourcedir;
// add root path if necessary, and point to course/config.json
const configPath = path.join(path.resolve(root, configDir), coursedir, 'config.' + jsonext);

adapt_framework/test.js

Lines 69 to 72 in 0da0411

'node',
'./node_modules/grunt/bin/grunt',
'diff',
shouldUseOutputDir && `--outputdir=${outputDir}`

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cheers Oli
I understand wanting to account for configurable paths, but the default of the framework build is to the directories stated so we should be okay with these assumptions when it comes to the GHA PR testing
Or did you have something further in mind?

Copy link
Member

@oliverfoster oliverfoster Oct 6, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few people have mentioned they'd like to perform tests based upon the course content, effectively removing some Quality Assurance tasks. We should start from facilitating that point of view, even if we never get there. As the first test, this already relies on the defined course data but will currently fail if used on a course in say, an AAT environment, which specifies outputdir.

Copy link
Member

@oliverfoster oliverfoster Oct 6, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The adapt-contrib-resources specific e2e tests should live in resources.


describe('Drawer', () => {
const checkDrawerLength = (count) => {
cy.get('.drawer__item').not('.u-display-none').should('have.length', count)
}

beforeEach(() => {
cy.visit('/');
cy.get('button[data-event="toggleDrawer"]').click()
})

it('should appear on the right hand side in menu view', () => {
cy.get('.drawer').should('have.css', 'right').and('match', /0px/)
});

it('should appear on the right hand side in course view', () => {
cy.get('button.drawer__close-btn').click()
cy.get('.menu-item .menu-item__button-container button').contains('View').first().click()
cy.get('button[data-event="toggleDrawer"]').click()
cy.get('.drawer').should('have.css', 'right').and('match', /0px/)
});

it(`should show ${Course._resources._resourcesItems.length} items`, () => {
checkDrawerLength(4)
});

it('should display the correct amount of items in each tab', () => {
cy.get('button.is-selected[id="resources__show-all"]').should('exist')

cy.get('button[id="resources__show-document"]').should('exist').click()
checkDrawerLength(1)

cy.get('button[id="resources__show-media"]').should('exist').click()
checkDrawerLength(1)

cy.get('button[id="resources__show-link"]').should('exist').click()
checkDrawerLength(2)
});

it('should display the correct drawer items', () => {
cy.get('.drawer__item').each(($item, index) => {
cy.get($item).within(() => {
cy.get('.drawer__item-title').should('contain', Course._resources._resourcesItems[index].title)
cy.get('.drawer__item-body').should('contain', Course._resources._resourcesItems[index].description)
cy.get('a').should('have.attr', 'target', '_blank').should('have.attr', 'href', Course._resources._resourcesItems[index]._link)
})
})
});

it('should be able to close the drawer by clicking X', () => {
cy.get('button.drawer__close-btn').click()

cy.get('.drawer').should('have.attr', 'aria-expanded', 'false')
});

it('should be able to close the drawer by hitting ESC', () => {
cy.get('.drawer').type('{esc}')

cy.get('.drawer').should('have.attr', 'aria-expanded', 'false')
});
});

Loading