forked from k-pet-group/Strype
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Moved parameter prompt tests out to their own new test file, to stop …
…the autocomplete file having too many tests.
- Loading branch information
1 parent
509dcc8
commit ba83e97
Showing
2 changed files
with
178 additions
and
83 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| // eslint-disable-next-line @typescript-eslint/no-var-requires | ||
| require("cypress-terminal-report/src/installLogsCollector")(); | ||
| import "@testing-library/cypress/add-commands"; | ||
| // Needed for the "be.sorted" assertion: | ||
| // eslint-disable-next-line @typescript-eslint/no-var-requires | ||
| chai.use(require("chai-sorted")); | ||
| import failOnConsoleError from "cypress-fail-on-console-error"; | ||
| failOnConsoleError(); | ||
|
|
||
| chai.Assertion.addMethod("beLocaleSorted", function () { | ||
| const $element = this._obj; | ||
|
|
||
| new chai.Assertion($element).to.be.exist; | ||
|
|
||
| const actual = [...$element] as string[]; | ||
| // Important to spread again to make a copy, as sort sorts in-place: | ||
| const expected = [...actual].sort((a, b) => a.localeCompare(b)); | ||
| expect(actual).to.deep.equal(expected); | ||
| }); | ||
|
|
||
|
|
||
| // Must clear all local storage between tests to reset the state: | ||
| beforeEach(() => { | ||
| cy.clearLocalStorage(); | ||
| cy.visit("/", {onBeforeLoad: (win) => { | ||
| win.localStorage.clear(); | ||
| win.sessionStorage.clear(); | ||
| }}); | ||
| }); | ||
|
|
||
| function withFrameId(inner : (frameId: number) => void) : void { | ||
| // We need a delay to make sure last DOM update has occurred: | ||
| cy.wait(600); | ||
| cy.get("#editor").then((eds) => { | ||
| const ed = eds.get()[0]; | ||
| // eslint-disable-next-line @typescript-eslint/ban-ts-comment | ||
| // @ts-ignore | ||
| const frameId = parseInt(new RegExp("input_frame_(\\d+)").exec(ed.getAttribute("data-slot-focus-id"))[1]); | ||
| // Call the inner function: | ||
| inner(frameId); | ||
| }); | ||
| } | ||
|
|
||
| function focusEditorAC(): void { | ||
| // Not totally sure why this hack is necessary, I think it's to give focus into the webpage via an initial click: | ||
| // (on the main code container frame -- would be better to retrieve it properly but the file won't compile if we use Apps.ts and/or the store) | ||
| cy.get("#frame_id_-3").focus(); | ||
| } | ||
|
|
||
| function withSelection(inner : (arg0: { id: string, cursorPos : number }) => void) : void { | ||
| // We need a delay to make sure last DOM update has occurred: | ||
| cy.wait(200); | ||
| cy.get("#editor").then((eds) => { | ||
| const ed = eds.get()[0]; | ||
| inner({id : ed.getAttribute("data-slot-focus-id") || "", cursorPos : parseInt(ed.getAttribute("data-slot-cursor") || "-2")}); | ||
| }); | ||
| } | ||
|
|
||
| const BUILTIN = "Python"; | ||
|
|
||
| // Checks that the first labelslot in the given frame has content equivalent to expectedState (with a dollar indicating cursor position), | ||
| // and equivalent to expectedStateWithPlaceholders if you count placeholders as the text for blank spans | ||
| // If the last parameter is missing, it's assumed that expectedStateWithPlaceholders is the same as expectedState | ||
| // (but without the dollar) | ||
| function assertState(frameId: number, expectedState : string, expectedStateWithPlaceholders?: string) : void { | ||
| expectedStateWithPlaceholders = expectedStateWithPlaceholders ?? expectedState.replaceAll("$", ""); | ||
| withSelection((info) => { | ||
| cy.get("#frameHeader_" + frameId + " #labelSlotsStruct" + frameId + "_0 .labelSlot-input").then((parts) => { | ||
| let content = ""; | ||
| let contentWithPlaceholders = ""; | ||
| for (let i = 0; i < parts.length; i++) { | ||
| const p : any = parts[i]; | ||
| let text = p.value || p.textContent || ""; | ||
|
|
||
| // If the text for a span is blank, use the placeholder since that's what the user will be seeing: | ||
| if (!text) { | ||
| // Get rid of zero-width spaces (trim() doesn't seem to do this): | ||
| contentWithPlaceholders += p.getAttribute("placeholder")?.replace(/\u200B/g,"") ?? ""; | ||
| } | ||
| else { | ||
| contentWithPlaceholders += text; | ||
| } | ||
|
|
||
| // If we're the focused slot, put a dollar sign in to indicate the current cursor position: | ||
| if (info.id === p.getAttribute("id") && info.cursorPos >= 0) { | ||
| text = text.substring(0, info.cursorPos) + "$" + text.substring(info.cursorPos); | ||
| } | ||
|
|
||
| content += text; | ||
| } | ||
| expect(content).to.equal(expectedState); | ||
| expect(contentWithPlaceholders).to.equal(expectedStateWithPlaceholders); | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| describe("Parameter prompts", () => { | ||
| // Each item is a triple: the module, the function name within the module, the list of param names | ||
| const rawFuncs : [string | null, string, string[]][] = [ | ||
| [null, "abs", ["x"]], | ||
| [null, "delattr", ["obj", "name"]], | ||
| [null, "dir", []], | ||
| [null, "globals", []], | ||
| [null, "setattr", ["obj, name, value"]], | ||
| ["collections", "namedtuple", ["typename", "field_names"]], | ||
| // These are object oriented items, so we are checking the self has been removed: | ||
| ["random", "randint", ["a, b"]], | ||
|
|
||
| ]; | ||
| if (Cypress.env("mode") !== "microbit") { | ||
| rawFuncs.push(["urllib.request", "urlopen", ["url"]]); | ||
| rawFuncs.push(["turtle", "Turtle", []]); | ||
| rawFuncs.push(["datetime", "date.fromtimestamp", ["timestamp"]]); | ||
| } | ||
| const funcs: {keyboardTypingToImport? : string, funcName: string, params: string[], displayName : string, acSection: string, acName: string}[] = []; | ||
| for (const rawFunc of rawFuncs) { | ||
| if (rawFunc[0]) { | ||
| // We need some kind of import; test three ways: | ||
| // The "import module" frame: | ||
| funcs.push({keyboardTypingToImport: "{uparrow}{uparrow}i" + rawFunc[0] + "{rightarrow}{downarrow}{downarrow}", funcName: rawFunc[0] + "." + rawFunc[1], params: rawFunc[2], acSection: rawFunc[0], acName: rawFunc[1], displayName: rawFunc[1] + " with import frame"}); | ||
| // The "from module import *" frame: | ||
| funcs.push({keyboardTypingToImport: "{uparrow}{uparrow}f" + rawFunc[0] + "{rightarrow}*{rightarrow}{downarrow}{downarrow}", funcName: rawFunc[1], params: rawFunc[2], acSection: rawFunc[0], acName: rawFunc[1], displayName: rawFunc[1] + " with from-import-* frame"}); | ||
| // The "from module import funcName" frame: | ||
| // Note that if funcName has a dot, we need to only use the part before the dot: | ||
| funcs.push({keyboardTypingToImport: "{uparrow}{uparrow}f" + rawFunc[0] + "{rightarrow}" + (rawFunc[1].includes(".") ? rawFunc[1].substring(0, rawFunc[1].indexOf(".")) : rawFunc[1]) + "{rightarrow}{downarrow}{downarrow}", funcName: rawFunc[1], params: rawFunc[2], acName: rawFunc[1], acSection: rawFunc[0], displayName: rawFunc[1] + " with from-import-funcName frame"}); | ||
| } | ||
| else { | ||
| // No import necessary | ||
| funcs.push({funcName: rawFunc[1], params: rawFunc[2], acSection: BUILTIN, acName: rawFunc[1], displayName: rawFunc[1]}); | ||
| } | ||
| } | ||
|
|
||
| for (const func of funcs) { | ||
| it("Shows prompts after manually writing function name and brackets for " + func.displayName, () => { | ||
| focusEditorAC(); | ||
| if (func.keyboardTypingToImport) { | ||
| cy.get("body").type(func.keyboardTypingToImport); | ||
| } | ||
| cy.get("body").type(" " + func.funcName + "("); | ||
| withFrameId((frameId) => assertState(frameId, func.funcName + "($)", func.funcName + "(" + func.params.join(", ") + ")")); | ||
| }); | ||
| it("Shows prompts after manually writing function name and brackets AND commas for " + func.displayName, () => { | ||
| focusEditorAC(); | ||
| if (func.keyboardTypingToImport) { | ||
| cy.get("body").type(func.keyboardTypingToImport); | ||
| } | ||
| cy.get("body").type(" " + func.funcName + "("); | ||
| // Type commas for num params minus 1: | ||
| for (let i = 0; i < func.params.length; i++) { | ||
| if (i > 0) { | ||
| cy.get("body").type(","); | ||
| } | ||
| withFrameId((frameId) => assertState(frameId, | ||
| func.funcName + "(" + ",".repeat(i) + "$)", | ||
| func.funcName + "(" + func.params.slice(0, i).join(",") + (i > 0 ? "," : "") + func.params.slice(i).join(", ") + ")")); | ||
| } | ||
|
|
||
| }); | ||
|
|
||
| it("Shows prompts in nested function (part 1) " + func.displayName, () => { | ||
| focusEditorAC(); | ||
| if (func.keyboardTypingToImport) { | ||
| cy.get("body").type(func.keyboardTypingToImport); | ||
| } | ||
| cy.get("body").type(" abs(" + func.funcName + "("); | ||
| withFrameId((frameId) => assertState(frameId, "abs(" + func.funcName + "($))", "abs(" + func.funcName + "(" + func.params.join(", ") + "))")); | ||
| }); | ||
|
|
||
| it("Shows prompts in nested function (part 2) " + func.displayName, () => { | ||
| focusEditorAC(); | ||
| if (func.keyboardTypingToImport) { | ||
| cy.get("body").type(func.keyboardTypingToImport); | ||
| } | ||
| cy.get("body").type(" max(0," + func.funcName + "("); | ||
| withFrameId((frameId) => assertState(frameId, "max(0," + func.funcName + "($))", "max(0," + func.funcName + "(" + func.params.join(", ") + "))")); | ||
| }); | ||
| } | ||
| }); |