解决k6脚本中open()函数导致的TypeError：正确加载外部数据

本文旨在解决k6性能测试脚本中因错误导入`open()`函数而导致的`typeerror: value is not an object: undefined`问题。我们将阐述`open()`作为k6全局函数的特性，并提供正确的外部数据加载方法，确保测试脚本能顺畅地读取和使用配置数据。

k6中加载外部数据的重要性

在进行性能测试时，经常需要从外部文件加载配置参数、测试数据或环境变量。k6提供了一个内置的open()函数，允许用户在脚本初始化阶段读取本地文件内容。这对于分离配置与代码、提高脚本的灵活性和可维护性至关重要。例如，我们可以将API的基准URL、认证凭据或测试用户列表存储在JSON文件中，然后在k6脚本中动态读取。

常见错误：TypeError: Value is not an object: undefined

许多k6新手在尝试使用open()函数时，可能会遇到一个TypeError: Value is not an object: undefined的错误。这个错误通常发生在尝试像导入其他k6模块（如http、check、sleep）一样导入open时。

考虑以下一个典型的k6脚本片段，它试图从data.json文件加载一个基础URL：

data.json:

{
  "base_url": "https://gorest.co.in/public/v2/users"
}

Sample.js (错误示例):

import http from 'k6/http';
import { check } from 'k6';
import { sleep } from 'k6';
import {open} from 'k6'; // 错误：不应导入open

const jsonData = JSON.parse(open(__ENV.resourseURL));
const baseURL = jsonData.base_url;

export let options = {
  vus: 10,
  duration: '1m',
};

export default function () {
  let response = http.get(baseURL);
  check(response, { 'Status is 200': (r) => r.status === 200 });
  sleep(1);
}

当使用命令 k6 run --env resourseURL=data.json Sample.js 运行上述脚本时，k6会抛出以下错误：

TypeError: Value is not an object: undefined

这个错误明确指出open函数在被调用时，其值是undefined，而不是一个可执行的函数对象。

怪兽AI数字人

数字人短视频创作，数字人直播，实时驱动数字人

44

查看详情

错误根源分析：open()的特性

open()函数是k6运行时环境在脚本初始化阶段提供的一个全局函数，它不属于任何特定的k6模块，因此不需要也不应该通过import语句显式导入。当您尝试 import {open} from 'k6'; 时，实际上是在告诉JavaScript引擎去k6模块中寻找一个名为open的导出成员。然而，k6模块并没有导出open，这导致导入的open变量变成了undefined。随后，当代码尝试调用这个undefined的变量时，就会触发TypeError。

open()函数主要用于在k6脚本的初始化上下文（init context）中同步读取本地文件。这个阶段在所有VUs（虚拟用户）启动之前执行，因此非常适合加载配置数据。

正确加载外部数据的方法

解决TypeError的方法非常简单：移除不必要的import {open} from 'k6';语句。由于open()是全局可用的，它可以在脚本的初始化阶段直接调用，无需任何导入。

Sample.js (正确示例):

import http from 'k6/http';
import { check, sleep } from 'k6'; // 优化：可合并导入

// 无需导入open，它是一个全局函数
const jsonData = JSON.parse(open(__ENV.resourseURL));
const baseURL = jsonData.base_url;

export let options = {
  vus: 10, // 模拟的虚拟用户数量
  duration: '1m', // 测试持续时间
};

export default function () {
  // 发送HTTP GET请求
  let response = http.get(baseURL);

  // 断言响应状态码为200
  check(response, { 'Status is 200': (r) => r.status === 200 });

  // 模拟用户思考时间
  sleep(1);
}

通过移除import {open} from 'k6';这一行，open函数将正确地解析为k6提供的全局函数，从而能够成功读取data.json文件并解析其内容。

注意事项与最佳实践

1. open()的使用时机：open()函数只能在脚本的初始化阶段（即export let options和export default function之外的顶层代码）使用。如果在default函数或其他测试逻辑内部调用open()，将会导致运行时错误，因为open()不是设计用于在VU执行期间同步文件I/O的。
2. 环境变量传递：通过--env标志传递文件路径是加载外部数据的常用且推荐方式。例如：k6 run --env resourseURL=data.json Sample.js。
3. 大型数据集的处理：对于需要加载大量数据（例如成千上万条测试数据）的场景，k6提供了SharedArray，它可以在所有VUs之间高效地共享数据，避免重复加载和内存浪费。SharedArray也需要在初始化阶段定义。
4. 模块导入的优化：像import { check } from 'k6'; import { sleep } from 'k6'; 这样的语句可以合并为 import { check, sleep } from 'k6';，使代码更简洁。

总结

TypeError: Value is not an object: undefined在k6脚本中通常是由于错误地尝试导入全局函数open()所致。理解open()作为k6初始化上下文中的全局函数这一特性，并避免对其进行显式导入，是解决此问题的关键。遵循正确的实践，可以确保k6脚本能够稳定高效地加载和利用外部配置及数据，从而构建出健壮的性能测试方案。

以上就是解决k6脚本中open()函数导致的TypeError：正确加载外部数据的详细内容，更多请关注php中文网其它相关文章！