ScenarioModel.js 13.5 KB
Newer Older
Q
q4speed 已提交
1 2 3
import {
  Element,
  TestElement,
Q
q4speed 已提交
4
  HashTree,
Q
q4speed 已提交
5 6 7
  TestPlan,
  ThreadGroup,
  HeaderManager,
Q
q4speed 已提交
8
  HTTPSamplerProxy,
Q
q4speed 已提交
9
  HTTPSamplerArguments,
Q
q4speed 已提交
10 11
  Arguments,
  DurationAssertion,
Q
q4speed 已提交
12 13
  ResponseCodeAssertion,
  ResponseDataAssertion,
Q
NaN  
q4speed 已提交
14
  ResponseHeadersAssertion,
Q
q4speed 已提交
15
  RegexExtractor, JSONPostProcessor, XPath2Extractor,
Q
q4speed 已提交
16 17
} from "./JMX";

Q
q4speed 已提交
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
export const uuid = function () {
  let d = new Date().getTime()
  let d2 = (performance && performance.now && (performance.now() * 1000)) || 0;
  return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
    let r = Math.random() * 16;
    if (d > 0) {
      r = (d + r) % 16 | 0;
      d = Math.floor(d / 16);
    } else {
      r = (d2 + r) % 16 | 0;
      d2 = Math.floor(d2 / 16);
    }
    return (c === 'x' ? r : (r & 0x3 | 0x8)).toString(16);
  });
}
Q
q4speed 已提交
33 34

export const BODY_TYPE = {
Q
q4speed 已提交
35 36 37
  KV: "KeyValue",
  FORM_DATA: "Form Data",
  RAW: "Raw"
Q
q4speed 已提交
38 39 40
}

export const ASSERTION_TYPE = {
Q
q4speed 已提交
41 42
  TEXT: "Text",
  REGEX: "Regex",
Q
q4speed 已提交
43
  DURATION: "Duration"
Q
q4speed 已提交
44 45
}

Q
q4speed 已提交
46 47 48 49 50 51
export const ASSERTION_REGEX_SUBJECT = {
  RESPONSE_CODE: "Response Code",
  RESPONSE_HEADERS: "Response Headers",
  RESPONSE_DATA: "Response Data"
}

Q
q4speed 已提交
52 53 54 55 56 57
export const EXTRACT_TYPE = {
  REGEX: "Regex",
  JSON_PATH: "JSONPath",
  XPATH: "XPath"
}

Q
q4speed 已提交
58
export class BaseConfig {
Q
q4speed 已提交
59 60 61 62 63 64 65 66 67 68 69

  set(options) {
    options = this.initOptions(options)

    for (let name in options) {
      if (options.hasOwnProperty(name)) {
        if (!(this[name] instanceof Array)) {
          this[name] = options[name];
        }
      }
    }
Q
q4speed 已提交
70 71
  }

Q
q4speed 已提交
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
  sets(types, options) {
    options = this.initOptions(options)
    if (types) {
      for (let name in types) {
        if (types.hasOwnProperty(name) && options.hasOwnProperty(name)) {
          options[name].forEach((o) => {
            this[name].push(new types[name](o));
          })
        }
      }
    }
  }

  initOptions(options) {
    return options || {};
  }
Q
q4speed 已提交
88 89 90 91

  isValid() {
    return true;
  }
Q
q4speed 已提交
92 93 94 95 96
}

export class Test extends BaseConfig {
  constructor(options) {
    super();
Q
q4speed 已提交
97
    this.version = '1.0.0';
Q
q4speed 已提交
98
    this.id = uuid();
Q
q4speed 已提交
99 100
    this.name = undefined;
    this.projectId = undefined;
Q
q4speed 已提交
101 102
    this.scenarioDefinition = [];

Q
q4speed 已提交
103 104
    this.set(options);
    this.sets({scenarioDefinition: Scenario}, options);
Q
q4speed 已提交
105 106
  }

Q
q4speed 已提交
107
  initOptions(options) {
Q
q4speed 已提交
108 109 110 111
    options = options || {};
    options.scenarioDefinition = options.scenarioDefinition || [new Scenario()];
    return options;
  }
Q
q4speed 已提交
112

Q
q4speed 已提交
113 114 115 116 117 118 119 120 121
  isValid() {
    for (let i = 0; i < this.scenarioDefinition.length; i++) {
      if (this.scenarioDefinition[i].isValid()) {
        return this.projectId && this.name;
      }
    }
    return false;
  }

Q
q4speed 已提交
122 123 124 125 126 127
  toJMX() {
    return {
      name: this.name + '.jmx',
      xml: new JMXGenerator(this).toXML()
    };
  }
Q
q4speed 已提交
128 129
}

Q
q4speed 已提交
130
export class Scenario extends BaseConfig {
Q
q4speed 已提交
131
  constructor(options) {
Q
q4speed 已提交
132
    super();
Q
q4speed 已提交
133 134
    this.name = undefined;
    this.url = undefined;
Q
q4speed 已提交
135
    this.variables = [];
Q
q4speed 已提交
136 137 138
    this.headers = [];
    this.requests = [];

Q
q4speed 已提交
139
    this.set(options);
Q
q4speed 已提交
140
    this.sets({variables: KeyValue, headers: KeyValue, requests: Request}, options);
Q
q4speed 已提交
141 142
  }

Q
q4speed 已提交
143
  initOptions(options) {
Q
q4speed 已提交
144 145 146
    options = options || {};
    options.requests = options.requests || [new Request()];
    return options;
Q
q4speed 已提交
147
  }
Q
q4speed 已提交
148 149 150 151

  clone() {
    return new Scenario(this);
  }
Q
q4speed 已提交
152 153 154 155 156 157 158 159 160

  isValid() {
    for (let i = 0; i < this.requests.length; i++) {
      if (this.requests[i].isValid()) {
        return true;
      }
    }
    return false;
  }
Q
q4speed 已提交
161 162
}

Q
q4speed 已提交
163
export class Request extends BaseConfig {
Q
q4speed 已提交
164
  constructor(options) {
Q
q4speed 已提交
165
    super();
Q
q4speed 已提交
166 167 168
    this.name = undefined;
    this.url = undefined;
    this.method = undefined;
Q
q4speed 已提交
169 170
    this.parameters = [];
    this.headers = [];
Q
q4speed 已提交
171 172 173
    this.body = undefined;
    this.assertions = undefined;
    this.extract = undefined;
Q
q4speed 已提交
174

Q
q4speed 已提交
175 176
    this.set(options);
    this.sets({parameters: KeyValue, headers: KeyValue}, options);
Q
q4speed 已提交
177 178
  }

Q
q4speed 已提交
179
  initOptions(options) {
Q
q4speed 已提交
180
    options = options || {};
Q
q4speed 已提交
181
    options.method = options.method || "GET";
Q
q4speed 已提交
182 183
    options.body = new Body(options.body);
    options.assertions = new Assertions(options.assertions);
Q
q4speed 已提交
184
    options.extract = new Extract(options.extract);
Q
q4speed 已提交
185
    return options;
Q
q4speed 已提交
186
  }
Q
q4speed 已提交
187 188 189 190

  isValid() {
    return !!this.url && !!this.method
  }
Q
q4speed 已提交
191 192
}

Q
q4speed 已提交
193
export class Body extends BaseConfig {
Q
q4speed 已提交
194
  constructor(options) {
Q
q4speed 已提交
195
    super();
Q
q4speed 已提交
196 197
    this.type = undefined;
    this.raw = undefined;
Q
q4speed 已提交
198 199
    this.kvs = [];

Q
q4speed 已提交
200 201
    this.set(options);
    this.sets({kvs: KeyValue}, options);
Q
q4speed 已提交
202 203
  }

Q
q4speed 已提交
204 205 206 207 208 209 210 211 212 213
  isValid() {
    if (this.isKV()) {
      return this.kvs.some(kv => {
        return kv.isValid();
      })
    } else {
      return !!this.raw;
    }
  }

Q
q4speed 已提交
214 215 216 217 218
  isKV() {
    return this.type === BODY_TYPE.KV;
  }
}

Q
q4speed 已提交
219
export class KeyValue extends BaseConfig {
Q
q4speed 已提交
220 221 222 223 224 225 226 227 228 229 230
  constructor() {
    let options, key, value;
    if (arguments.length === 1) {
      options = arguments[0];
    }

    if (arguments.length === 2) {
      key = arguments[0];
      value = arguments[1];
    }

Q
q4speed 已提交
231
    super();
Q
q4speed 已提交
232 233
    this.name = key;
    this.value = value;
Q
q4speed 已提交
234

Q
q4speed 已提交
235
    this.set(options);
Q
q4speed 已提交
236
  }
Q
q4speed 已提交
237 238 239 240

  isValid() {
    return !!this.name || !!this.value;
  }
Q
q4speed 已提交
241 242
}

Q
q4speed 已提交
243
export class Assertions extends BaseConfig {
Q
q4speed 已提交
244
  constructor(options) {
Q
q4speed 已提交
245
    super();
Q
q4speed 已提交
246 247
    this.text = [];
    this.regex = [];
Q
q4speed 已提交
248
    this.duration = undefined;
Q
q4speed 已提交
249

Q
q4speed 已提交
250
    this.set(options);
Q
q4speed 已提交
251
    this.sets({text: Text, regex: Regex}, options);
Q
q4speed 已提交
252 253
  }

Q
q4speed 已提交
254
  initOptions(options) {
Q
q4speed 已提交
255
    options = options || {};
Q
q4speed 已提交
256
    options.duration = new Duration(options.duration);
Q
q4speed 已提交
257
    return options;
Q
q4speed 已提交
258 259 260
  }
}

Q
q4speed 已提交
261
export class AssertionType extends BaseConfig {
Q
q4speed 已提交
262
  constructor(type) {
Q
q4speed 已提交
263
    super();
Q
q4speed 已提交
264 265 266 267 268 269 270
    this.type = type;
  }
}

export class Text extends AssertionType {
  constructor(options) {
    super(ASSERTION_TYPE.TEXT);
Q
q4speed 已提交
271 272 273
    this.subject = undefined;
    this.condition = undefined;
    this.value = undefined;
Q
q4speed 已提交
274

Q
q4speed 已提交
275
    this.set(options);
Q
q4speed 已提交
276 277 278 279 280 281
  }
}

export class Regex extends AssertionType {
  constructor(options) {
    super(ASSERTION_TYPE.REGEX);
Q
q4speed 已提交
282 283 284
    this.subject = undefined;
    this.expression = undefined;
    this.description = undefined;
Q
q4speed 已提交
285

Q
q4speed 已提交
286
    this.set(options);
Q
q4speed 已提交
287
  }
Q
q4speed 已提交
288 289 290 291

  isValid() {
    return !!this.subject && !!this.expression;
  }
Q
q4speed 已提交
292 293
}

Q
q4speed 已提交
294
export class Duration extends AssertionType {
Q
q4speed 已提交
295
  constructor(options) {
Q
q4speed 已提交
296
    super(ASSERTION_TYPE.DURATION);
Q
q4speed 已提交
297
    this.value = undefined;
Q
q4speed 已提交
298

Q
q4speed 已提交
299
    this.set(options);
Q
q4speed 已提交
300
  }
Q
q4speed 已提交
301 302 303 304

  isValid() {
    return !!this.value;
  }
Q
q4speed 已提交
305 306
}

Q
q4speed 已提交
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
export class Extract extends BaseConfig {
  constructor(options) {
    super();
    this.regex = [];
    this.json = [];
    this.xpath = [];

    this.set(options);
    let types = {
      json: ExtractJSONPath,
      xpath: ExtractXPath,
      regex: ExtractRegex
    }
    this.sets(types, options);
  }
}

export class ExtractType extends BaseConfig {
  constructor(type) {
    super();
    this.type = type;
  }
}

export class ExtractCommon extends ExtractType {
  constructor(type, options) {
    super(type);
Q
q4speed 已提交
334
    this.variable = undefined;
Q
q4speed 已提交
335
    this.value = ""; // ${variable}
Q
q4speed 已提交
336 337
    this.expression = undefined;
    this.description = undefined;
Q
q4speed 已提交
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364

    this.set(options);
  }

  isValid() {
    return !!this.variable && !!this.expression;
  }
}

export class ExtractRegex extends ExtractCommon {
  constructor(options) {
    super(EXTRACT_TYPE.REGEX, options);
  }
}

export class ExtractJSONPath extends ExtractCommon {
  constructor(options) {
    super(EXTRACT_TYPE.JSON_PATH, options);
  }
}

export class ExtractXPath extends ExtractCommon {
  constructor(options) {
    super(EXTRACT_TYPE.XPATH, options);
  }
}

Q
NaN  
q4speed 已提交
365
/** ------------------------------------------------------------------------ **/
Q
q4speed 已提交
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
const JMX_ASSERTION_CONDITION = {
  MATCH: 1,
  CONTAINS: 1 << 1,
  NOT: 1 << 2,
  EQUALS: 1 << 3,
  SUBSTRING: 1 << 4,
  OR: 1 << 5
}

class JMXRequest {
  constructor(request) {
    if (request && request instanceof Request && request.url) {
      let url = new URL(request.url);
      this.method = request.method;
      this.hostname = url.hostname;
      this.pathname = url.pathname;
      this.port = url.port;
      this.protocol = url.protocol.split(":")[0];
      if (this.method.toUpperCase() !== "GET") {
        this.pathname += url.search.replace('&', '&amp;');
      }
    }
  }
}

class JMeterTestPlan extends Element {
  constructor() {
    super('jmeterTestPlan', {
      version: "1.2", properties: "5.0", jmeter: "5.2.1"
    });

    this.add(new HashTree());
  }

  put(te) {
    if (te instanceof TestElement) {
      this.elements[0].add(te);
    }
  }
}

class JMXGenerator {
  constructor(test) {
409
    if (!test || !test.id || !(test instanceof Test)) return undefined;
Q
q4speed 已提交
410 411

    let testPlan = new TestPlan(test.name);
412 413 414 415 416 417 418
    this.addScenarios(testPlan, test.scenarioDefinition);

    this.jmeterTestPlan = new JMeterTestPlan();
    this.jmeterTestPlan.put(testPlan);
  }

  addScenarios(testPlan, scenarios) {
Q
q4speed 已提交
419 420
    scenarios.forEach(s => {
      let scenario = s.clone();
421 422
      scenario.name = this.replace(scenario.name);

423
      let threadGroup = new ThreadGroup(scenario.name || "");
Q
q4speed 已提交
424

Q
q4speed 已提交
425 426 427 428
      this.addScenarioVariables(threadGroup, scenario);

      this.addScenarioHeaders(threadGroup, scenario);

Q
q4speed 已提交
429
      scenario.requests.forEach(request => {
Q
q4speed 已提交
430 431
        if (!request.isValid()) return;

432 433
        request.name = this.replace(request.name);

434
        let httpSamplerProxy = new HTTPSamplerProxy(request.name || "", new JMXRequest(request));
Q
q4speed 已提交
435 436 437 438 439 440 441 442 443 444 445

        this.addRequestHeader(httpSamplerProxy, request);

        if (request.method.toUpperCase() === 'GET') {
          this.addRequestArguments(httpSamplerProxy, request);
        } else {
          this.addRequestBody(httpSamplerProxy, request);
        }

        this.addRequestAssertion(httpSamplerProxy, request);

Q
q4speed 已提交
446 447
        this.addRequestExtractor(httpSamplerProxy, request);

Q
q4speed 已提交
448 449 450 451 452
        threadGroup.put(httpSamplerProxy);
      })

      testPlan.put(threadGroup);
    })
453
  }
Q
q4speed 已提交
454

Q
q4speed 已提交
455
  addScenarioVariables(threadGroup, scenario) {
Q
q4speed 已提交
456
    let args = this.replaceKV(scenario.variables);
Q
q4speed 已提交
457 458 459 460 461 462 463
    if (args.length > 0) {
      let name = scenario.name + " Variables"
      threadGroup.put(new Arguments(name, args));
    }
  }

  addScenarioHeaders(threadGroup, scenario) {
Q
q4speed 已提交
464
    let headers = this.replaceKV(scenario.headers);
Q
q4speed 已提交
465 466 467 468 469 470
    if (headers.length > 0) {
      let name = scenario.name + " Headers"
      threadGroup.put(new HeaderManager(name, headers));
    }
  }

Q
q4speed 已提交
471 472
  addRequestHeader(httpSamplerProxy, request) {
    let name = request.name + " Headers";
Q
q4speed 已提交
473
    let headers = this.replaceKV(request.headers);
Q
q4speed 已提交
474
    if (headers.length > 0) {
Q
q4speed 已提交
475
      httpSamplerProxy.put(new HeaderManager(name, headers));
Q
q4speed 已提交
476
    }
Q
q4speed 已提交
477 478 479
  }

  addRequestArguments(httpSamplerProxy, request) {
Q
q4speed 已提交
480
    let args = this.replaceKV(request.parameters);
Q
q4speed 已提交
481
    if (args.length > 0) {
Q
q4speed 已提交
482
      httpSamplerProxy.add(new HTTPSamplerArguments(args));
Q
q4speed 已提交
483
    }
Q
q4speed 已提交
484 485 486 487 488
  }

  addRequestBody(httpSamplerProxy, request) {
    let body = [];
    if (request.body.isKV()) {
Q
q4speed 已提交
489
      body = this.replaceKV(request.body.kvs);
Q
q4speed 已提交
490
    } else {
Q
q4speed 已提交
491
      httpSamplerProxy.boolProp('HTTPSampler.postBodyRaw', true);
Q
q4speed 已提交
492
      body.push({name: '', value: this.replace(request.body.raw), encode: false});
Q
q4speed 已提交
493 494
    }

Q
q4speed 已提交
495
    httpSamplerProxy.add(new HTTPSamplerArguments(body));
Q
q4speed 已提交
496 497 498 499 500 501
  }

  addRequestAssertion(httpSamplerProxy, request) {
    let assertions = request.assertions;
    if (assertions.regex.length > 0) {
      assertions.regex.filter(this.filter).forEach(regex => {
Q
q4speed 已提交
502
        httpSamplerProxy.put(this.getAssertion(regex));
Q
q4speed 已提交
503 504 505 506
      })
    }

    if (assertions.duration.isValid()) {
Q
q4speed 已提交
507
      let name = "Response In Time: " + assertions.duration.value
Q
q4speed 已提交
508
      httpSamplerProxy.put(new DurationAssertion(name, assertions.duration.value));
Q
q4speed 已提交
509 510 511 512
    }
  }

  getAssertion(regex) {
Q
q4speed 已提交
513
    let name = this.replace(regex.description);
Q
q4speed 已提交
514
    let type = JMX_ASSERTION_CONDITION.CONTAINS; // 固定用Match,自己写正则
Q
q4speed 已提交
515
    let value = this.replace(regex.expression);
Q
q4speed 已提交
516 517 518 519 520 521 522 523 524 525
    switch (regex.subject) {
      case ASSERTION_REGEX_SUBJECT.RESPONSE_CODE:
        return new ResponseCodeAssertion(name, type, value);
      case ASSERTION_REGEX_SUBJECT.RESPONSE_DATA:
        return new ResponseDataAssertion(name, type, value);
      case ASSERTION_REGEX_SUBJECT.RESPONSE_HEADERS:
        return new ResponseHeadersAssertion(name, type, value);
    }
  }

Q
q4speed 已提交
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
  addRequestExtractor(httpSamplerProxy, request) {
    let extract = request.extract;
    if (extract.regex.length > 0) {
      extract.regex.filter(this.filter).forEach(regex => {
        httpSamplerProxy.put(this.getExtractor(regex));
      })
    }

    if (extract.json.length > 0) {
      extract.json.filter(this.filter).forEach(json => {
        httpSamplerProxy.put(this.getExtractor(json));
      })
    }

    if (extract.xpath.length > 0) {
      extract.xpath.filter(this.filter).forEach(xpath => {
        httpSamplerProxy.put(this.getExtractor(xpath));
      })
    }
  }

  getExtractor(extractCommon) {
    let props = {
Q
q4speed 已提交
549 550
      name: this.replace(extractCommon.variable),
      expression: this.replace(extractCommon.expression),
Q
q4speed 已提交
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
    }
    let testName = props.name
    switch (extractCommon.type) {
      case EXTRACT_TYPE.REGEX:
        testName += " RegexExtractor";
        props.headers = "false"; // 对应jMeter body
        props.template = "$1$";
        return new RegexExtractor(testName, props);
      case EXTRACT_TYPE.JSON_PATH:
        testName += " JSONExtractor";
        return new JSONPostProcessor(testName, props);
      case EXTRACT_TYPE.XPATH:
        testName += " XPath2Evaluator";
        return new XPath2Extractor(testName, props);
    }
  }

Q
q4speed 已提交
568 569 570 571
  filter(config) {
    return config.isValid();
  }

Q
q4speed 已提交
572
  replace(str) {
Q
q4speed 已提交
573
    if (!str || !(typeof str === 'string')) return str;
Q
q4speed 已提交
574 575 576 577 578 579 580 581 582 583 584 585 586
    return str.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/'/g, "&apos;").replace(/"/g, "&quot;");
  }

  replaceKV(kvs) {
    let results = [];
    kvs.filter(this.filter).forEach(kv => {
      let name = this.replace(kv.name);
      let value = this.replace(kv.value);
      results.push(new KeyValue(name, value));
    });
    return results;
  }

Q
q4speed 已提交
587 588 589 590 591 592 593 594
  toXML() {
    let xml = '<?xml version="1.0" encoding="UTF-8"?>\n';
    xml += this.jmeterTestPlan.toXML();
    return xml;
  }
}