collabora-online/cypress_test/integration_tests/common/calc_helper.js

/* global cy expect Cypress require expect */

var helper = require('./helper');

// Click on the formula bar.
// mouseover is triggered to avoid leaving the mouse on the Formula-Bar,
// which shows the tooltip and messes up tests.
function clickFormulaBar() {
	cy.log('>> clickFormulaBar - start');

	// The inputbar_container is 100% width, which
	// can extend behind the sidebar. So we can't
	// rely on its width. Instead, we rely on the
	// canvas, which is accurately sized.
	// N.B. Setting the width of the inputbar_container
	// is futile because it messes the size of the canvas.
	helper.doIfOnMobile(function() {
		helper.waitUntilIdle('#sc_input_window.formulabar');
	});

	cy.cGet('#sc_input_window.formulabar').focus();
	cy.cGet('body').trigger('mouseover');

	cy.log('<< clickFormulaBar - end');
}

// Click on the first cell of the sheet (A1), we use the document
// top left corner to achive that, so it work's if the view is at the
// start of the sheet.
// Parameters:
// firstClick - this is the first click on the cell. It matters on mobile only,
//              becasue on mobile, the first click/tap selects the cell, the second
//              one makes the document to step in cell editing.
// dblClick - to do a double click or not. The result of double click is that the cell
//            editing it triggered both on desktop and mobile.
function clickOnFirstCell(firstClick = true, dblClick = false, isA1 = true) {
	cy.log('>> clickOnFirstCell - start');
	cy.log('Param - firstClick: ' + firstClick);
	cy.log('Param - dblClick: ' + dblClick);

	// Use the tile's edge to find the first cell's position
	cy.cGet('#map')
		.then(function(items) {
			expect(items).to.have.lengthOf(1);
			var XPos = items[0].getBoundingClientRect().left + 10;
			var YPos = items[0].getBoundingClientRect().top + 10;
			if (dblClick)
				cy.cGet('body').click(XPos, YPos).dblclick(XPos, YPos);
			else
				cy.cGet('body').click(XPos, YPos);
		});

	if (firstClick && !dblClick) {
		cy.cGet('#test-div-overlay-cell-cursor-border-0')
			.should(function (elem) {
				expect(helper.Bounds.parseBoundsJson(elem.text()).left).to.be.equal(0);
				expect(helper.Bounds.parseBoundsJson(elem.text()).top).to.be.equal(0);
			});
	} else {
		cy.cGet('.cursor-overlay .blinking-cursor').should('be.visible');
	}

	if (isA1)
		cy.cGet('input#addressInput-input').should('have.prop', 'value', 'A1');

	cy.log('<< clickOnFirstCell - end');
}

// Double click on the A1 cell.
function dblClickOnFirstCell() {
	cy.log('>> dblClickOnFirstCell - start');

	clickOnFirstCell(false, true);

	cy.log('<< dblClickOnFirstCell - end');
}

// Type some text into the formula bar.
// Parameters:
// text - the text the method type into the formula bar's intput field.
function typeIntoFormulabar(text) {
	cy.log('>> typeIntoFormulabar - start');

	cy.cGet('#sc_input_window.formulabar')
		.then(function(cursor) {
			if (!Cypress.dom.isVisible(cursor)) {
				clickFormulaBar();
			}
		});

	cy.cGet('#sc_input_window.formulabar').click(); // This probably shouldn't be here, but acceptformula doesn't get visible without a click.
	cy.cGet('#sc_input_window.formulabar').should('have.class', 'focused');

	helper.doIfOnMobile(function() {
		cy.cGet('#toolbar-up #acceptformula').should('be.visible');
		cy.cGet('#toolbar-up #cancelformula').should('be.visible');
	});
	helper.doIfOnDesktop(function() {
		cy.cGet('#acceptformula').should('be.visible');
		cy.cGet('#cancelformula').should('be.visible');
	});

	cy.cGet('body').type(text);

	cy.log('<< typeIntoFormulabar - end');
}

// Remove exisiting text selection by clicking on
// row headers at the center position, until a
// a row is selected (and text seletion is removed).
function removeTextSelection() {
	cy.log('>> removeTextSelection - start');

	cy.cGet('[id="test-div-row header"]')
		.then(function(header) {
			expect(header).to.have.lengthOf(1);
			var rect = header[0].getBoundingClientRect();
			var posX = (rect.right + rect.left) / 2.0;
			var posY = (rect.top + rect.bottom) / 2.0;

			var moveY = 0.0;
			cy.waitUntil(function() {
				cy.cGet('body').click(posX, posY + moveY);

				moveY += 1.0;
				var regex = /A([0-9]+):(AMJ|XFD)\1$/;
				return cy.cGet('input#addressInput-input')
					.should('have.prop', 'value')
					.then(function(value) {
						return regex.test(value);
					});
			});
		});

	cy.log('<< removeTextSelection - end');
}

// Select the enitre sheet, using the select all button
// at the corner of the row and column headers.
// An additional thing, what this method do is remove
// preexisitng text selection. Otherwise with having the
// text selection, select all would select only the content
// of the currently edited cell instead of the whole table.
function selectEntireSheet() {
	cy.log('>> selectEntireSheet - start');

	removeTextSelection();

	cy.cGet('[id="test-div-corner header"]')
		.then(function(items) {
			expect(items).to.have.lengthOf(1);
			var corner = items[0];
			var XPos = (corner.getBoundingClientRect().right + items[0].getBoundingClientRect().left) / 2;
			var YPos = items[0].getBoundingClientRect().bottom - 10;
			cy.cGet('body').click(XPos, YPos);
		});

	helper.doIfOnMobile(function() {
		cy.cGet('#test-div-cell_selection_handle_start').should('exist');
	});

	var regex = /^A1:(AMJ|XFD)1048576$/;
	cy.cGet('input#addressInput-input')
		.should('have.prop', 'value')
		.then(function(value) {
			return regex.test(value);
		});

	cy.log('<< selectEntireSheet - end');
}

// Select first column of a calc document.
// We try to achive this by clicking on the left end
// of the column headers. Of course if the first column
// has a very small width, then this might fail.
function selectFirstColumn() {
	cy.log('>> selectFirstColumn - start');

	cy.cGet('[id="test-div-column header"]')
		.then(function(items) {
			expect(items).to.have.lengthOf(1);

			var bounds = items[0].getBoundingClientRect();
			var XPos = bounds.left + 10;
			var YPos = (bounds.top + bounds.bottom) / 2;
			cy.cGet('body').click(XPos, YPos);
		});

		cy.cGet('input#addressInput-input').should('have.prop', 'value', 'A1:A1048576');

	cy.log('<< selectFirstColumn - end');
}

function ensureViewContainsCellCursor() {
	cy.log('>> ensureViewContainsCellCursor - start');

	var sheetViewBounds = new helper.Bounds();
	var sheetCursorBounds = new helper.Bounds();

	helper.getOverlayItemBounds('#test-div-overlay-cell-cursor-border-0', sheetCursorBounds);
	helper.getItemBounds('#test-div-tiles', sheetViewBounds);

	cy.wrap(true).then(function () {
		cy.log('ensureViewContainsCellCursor: cursor-area is ' + sheetCursorBounds.toString() + ' view-area is ' + sheetViewBounds.toString());
		expect(sheetViewBounds.contains(sheetCursorBounds)).to.equal(true, 'view-area must contain cursor-area');
	});

	cy.log('<< ensureViewContainsCellCursor - end');
}

function assertSheetContents(expectedData, copy) {
	cy.log('>> assertSheetContents - start');

	selectEntireSheet();
	if (copy === true) {
		helper.copy();
	}
	assertDataClipboardTable(expectedData);

	cy.log('<< assertSheetContents - end');
}

function assertDataClipboardTable(expectedData) {
	cy.log('>> assertDataClipboardTable - start');

	cy.cGet('#copy-paste-container table td').should(function($td) {
		expect($td).to.have.length(expectedData.length);
		var actualData = $td.map(function(i,el) {
			return Cypress.$(el).text();
		}).get();
		expect(actualData).to.deep.eq(expectedData);
	});

	cy.log('<< assertDataClipboardTable - end');
}

function selectCellsInRange(range) {
	cy.log('>> selectCellsInRange - start');

	cy.cGet('#formulabar #addressInput-input')
		.clear()
		.type(range + '{enter}');

	cy.log('<< selectCellsInRange - end');
}

function openAutoFilterMenu(secondColumn) {
	cy.log('>> openAutoFilterMenu - start');

	let XPos = 95;
	let YPos = 10;

	if (secondColumn) {
		XPos += 105;
	}

	cy.cGet('#map').then(function(items) { expect(items).to.have.lengthOf(1); });
	cy.cGet('#map').click(XPos, YPos);

	cy.log('<< openAutoFilterMenu - end');
}

function assertNumberofSheets(n) {
	cy.cGet('button.spreadsheet-tab').should('have.length', n);
}

function selectOptionFromContextMenu(contextMenu) {
	cy.wait(1000);
	cy.cGet('.spreadsheet-tab.spreadsheet-tab-selected').rightclick();
	cy.cGet('body').contains('.context-menu-link', contextMenu).click();
}

function selectOptionMobileWizard(menu) {
	var eventOptions = {
		force: true,
		button: 0,
		pointerType: 'mouse'
	};

	cy.cGet('.spreadsheet-tab.spreadsheet-tab-selected')
		.trigger('pointerdown', eventOptions)
		.wait(1000);

	cy.cGet('body').contains('.ui-header.level-0.mobile-wizard.ui-widget', menu)
		.click();
}

module.exports.clickOnFirstCell = clickOnFirstCell;
module.exports.dblClickOnFirstCell = dblClickOnFirstCell;
module.exports.clickFormulaBar = clickFormulaBar;
module.exports.typeIntoFormulabar = typeIntoFormulabar;
module.exports.removeTextSelection = removeTextSelection;
module.exports.selectEntireSheet = selectEntireSheet;
module.exports.selectFirstColumn = selectFirstColumn;
module.exports.ensureViewContainsCellCursor = ensureViewContainsCellCursor;
module.exports.assertSheetContents = assertSheetContents;
module.exports.selectCellsInRange = selectCellsInRange;
module.exports.openAutoFilterMenu = openAutoFilterMenu;
module.exports.assertNumberofSheets = assertNumberofSheets;
module.exports.selectOptionFromContextMenu = selectOptionFromContextMenu;
module.exports.selectOptionMobileWizard = selectOptionMobileWizard;