File size: 7,862 Bytes
71174bc | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 | import { store } from "@/Store";
import { ITestCommand, TestCommand } from "./TestInterfaces";
/**
* Adds the specified commands to the list of commands to run.
*
* @param {any[]} cmds The commands to add.
*/
export function addTestsToCmdList(cmds: any[]) {
const testsStr = store.state.test.cmds;
const tests = testsStr === "" ? [] : JSON.parse(testsStr);
tests.push(...cmds);
store.commit("setVar", {
name: "cmds",
val: JSON.stringify(tests),
module: "test",
});
}
/**
* A class to generate the command to type text into a selector. Should only be
* called from class TestCmdList. The parent that all test commands should
* inherit from.
*/
export abstract class TestCmdParent {
/**
* Generates the command.
*
* @returns {ITestCommand} The command.
*/
abstract get cmd(): ITestCommand;
/**
* On rare occasions, you might want to add a test directly to the list,
* outside of the TestCmdList system. Not recommended, but you can use this
* if needed.
*/
addToCmdList() {
addTestsToCmdList([this.cmd]);
}
}
/**
* A class to generate the command to click a selector. Should only be called
* from class TestCmdList.
*/
export class TestClick extends TestCmdParent {
private selector: string;
private shiftPressed: boolean;
/**
* Creates an instance of TestClick.
*
* @param {string} selector The selector to click.
* @param {boolean} [shiftPressed=false] If true, the shift key will be
* pressed while clicking.
*/
constructor(selector: string, shiftPressed = false) {
super();
this.selector = selector;
this.shiftPressed = shiftPressed;
}
/**
* Generates the command to click the selector.
*
* @returns {ITestCommand} The command to click the selector.
*/
get cmd(): ITestCommand {
return {
selector: this.selector,
cmd: TestCommand.Click,
data: this.shiftPressed,
};
}
}
/**
* A class to generate the command to wait for a specified duration. Should
* only be called from class TestCmdList.
*/
export class TestWait extends TestCmdParent {
private duration: number;
/**
* Creates an instance of TestWait.
*
* @param {number} [durationInSecs=1] The duration to wait, in seconds.
*/
constructor(durationInSecs = 1) {
super();
this.duration = durationInSecs;
}
/**
* Generates the command to wait for the specified duration.
*
* @returns {ITestCommand} The command to wait for the specified duration.
*/
get cmd(): ITestCommand {
return {
cmd: TestCommand.Wait,
data: this.duration,
};
}
}
/**
* A class to generate the command to type text into a selector. Should only be
* called from class TestCmdList.
*/
export class TestText extends TestCmdParent {
private selector: string;
private text: string;
/**
* Creates an instance of TestText.
*
* @param {string} selector The selector to type into.
* @param {string} text The text to type.
*/
constructor(selector: string, text: string) {
super();
this.selector = selector;
this.text = text;
}
/**
* Generates the command to type the specified text into the specified
* selector.
*
* @returns {ITestCommand} The command to type the specified text into the
* specified selector.
*/
get cmd(): ITestCommand {
return {
selector: this.selector,
cmd: TestCommand.Text,
data: this.text,
};
}
}
/**
* A class to generate the command to wait until the specified regex is found in
* the specified selector. Should only be called from class TestCmdList.
*/
export class TestWaitUntilRegex extends TestCmdParent {
private selector: string;
private regex: string;
/**
* Creates an instance of TestWaitUntilRegex.
*
* @param {string} selector The selector to monitor.
* @param {string} regex The regex to wait for.
*/
constructor(selector: string, regex: string) {
super();
this.selector = selector;
this.regex = regex;
}
/**
* Generates the command to wait until the specified regex is found in the
* specified selector.
*
* @returns {ITestCommand} The command to wait until the specified regex is
* found in the specified selector.
*/
get cmd(): ITestCommand {
return {
selector: this.selector,
cmd: TestCommand.WaitUntilRegex,
data: this.regex,
};
}
}
/**
* A class to generate the command to wait until the specified regex is not
* found in the specified selector. Should only be called from class
* TestCmdList.
*/
export class TestWaitUntilNotRegex extends TestCmdParent {
private selector: string;
private regex: string;
/**
* Creates an instance of TestWaitUntilRegex.
*
* @param {string} selector The selector to monitor.
* @param {string} regex The regex to wait for.
*/
// eslint-disable-next-line sonarjs/no-identical-functions
constructor(selector: string, regex: string) {
super();
this.selector = selector;
this.regex = regex;
}
/**
* Generates the command to wait until the specified regex is found in the
* specified selector.
*
* @returns {ITestCommand} The command to wait until the specified regex is
* found in the specified selector.
*/
get cmd(): ITestCommand {
return {
selector: this.selector,
cmd: TestCommand.WaitUntilNotRegex,
data: this.regex,
};
}
}
/**
* A class to generate the command to upload a file. Should only be called from
* class TestCmdList.
*/
export class TestUpload extends TestCmdParent {
private selector: string;
private filePath: string;
/**
* Creates an instance of TestUpload.
*
* @param {string} selector The selector to upload to.
* @param {string} filePath The file path to upload.
*/
constructor(selector: string, filePath: string) {
super();
this.selector = selector;
if (filePath.startsWith("file://")) {
filePath = filePath.substring(7);
}
this.filePath = filePath;
}
/**
* Generates the command to upload the specified file to the specified
* selector.
*
* @returns {ITestCommand} The command to upload the specified file to the
* specified selector.
*/
get cmd(): ITestCommand {
return {
selector: this.selector,
cmd: TestCommand.Upload,
data: this.filePath,
};
}
}
/**
* A class to generate the command for displaying a note during a tour. Should
* only be called from class TestCmdList.
*/
export class TestTourNote extends TestCmdParent {
private selector: string;
private message: string;
/**
* Creates an instance of TestTourNote.
*
* @param {string} selector The selector for the element to associate the
* note with.
* @param {string} message The message to display in the note.
*/
constructor(selector: string, message: string) {
super();
this.selector = selector;
this.message = message;
}
/**
* Generates the command to display the tour note.
*
* @returns {ITestCommand} The command.
*/
get cmd(): ITestCommand {
return {
selector: this.selector,
cmd: TestCommand.TourNote,
data: this.message,
};
}
}
|