mock firebolt下载 - mock firebolt源代码下载

mock firebolt

其他源码

v1.0.2

下载

模拟火弩箭

模拟 Firebolt 允许应用程序开发人员创建兼容 Firebolt 的应用程序，以“人为地”导致对 Firebolt SDK 的调用返回与在他们可能拥有的任何设备上运行的真实 Firebolt 返回的响应不同的响应。

这可能会被使用，例如：

由只有 STB 的开发人员让 Firebolt 进行应答，就好像它是电视一样（反之亦然）
测试辅助功能设置、广告设置等的变化。
测试应用程序如何响应 Firebolt SDK 中的错误
测试 Firebolt SDK 等的缓慢响应。

未来：可以充当在真实设备上运行的真实 Firebolt 的反向代理。

目标：

使应用程序开发人员能够尽可能长时间地无需真实设备即可提高工作效率
使应用程序开发人员能够强制 Firebolt 做出各种响应，以在多个设备“上”测试应用程序、测试边缘情况并模拟错误

（注意：标准 SDK 内置了静态模拟，但它是不可控制或可扩展的。）

另请注意，由于 SDK 不会验证方法调用的参数，因此应用程序开发人员还可以使用 Mock Firebolt 作为验证 Firebolt 方法调用是否正确的方法。

特征

可控模拟 Firebolt 服务器（NodeJS websocket + HTTP 服务器）
通过控制平面 RESTful API、CLI、Web 管理 UI（即将）、浏览器扩展（即将）控制模拟方法响应
100% OpenRPC 驱动；实现中没有特定于 SDK 的详细信息
支持 Firebolt SDK：核心和管理
完整的文档
Docker 支持
方法调用上发送的所有参数的验证（基于 OpenRPC 规范）
所有模拟方法覆盖值的验证（基于 OpenRPC 规范）
一次设置多个方法覆盖
命令行界面；对于一次加载 JSON 或 YAML 文件中的所有方法覆盖（“导入”）特别有用
CLI 支持 JSON 和 YAML 文件
将方法的响应指定为非错误结果或错误
将方法的响应指定为 JavaScript 函数，该函数接收传递给方法调用的参数
在用于指定方法响应的函数之间共享状态
指定响应序列（失败一次、成功一次等）
通过控制平面（RESTful API、CLI 等）将事件发送到 Firebolt SDK
通过控制平面（RESTful API、CLI 等）将事件发送到多个应用程序
通过控制平面将定时事件序列发送到 Firebolt SDK（很快）
导入/导出以加载/保存模拟响应值
魔法日期/时间变量支持（例如，{{+1h|x}}、{{20:00|YYYY-MM-DD HH:mm:ssZ}}）
设置每个方法或全局的响应延迟
多用户支持（使用 websocket URL 上的路径）
用于设置模拟响应的 Web 管理 UI（很快）
用于发送 Firebolt 生命周期事件的浏览器扩展
用于设置模拟响应的浏览器扩展（有一天）

建筑学：

架构图

回购内容

该存储库包含以下元素：

文档/
- 文档
服务器/
- 充当模拟 Firebolt 服务器的 NodeJS 服务器
  - 响应 Firebolt SDK 请求并通过套接字传输层将事件发送到 Firebolt SDK
  - 提供一个 RESTful 界面供控制工具（CLI、浏览器扩展、Web 管理应用程序）使用
  - 提供基于 Express 的 Web 管理应用程序，可用于影响模拟 Firebolt 服务器的行为
    - 注意： Web 管理应用程序尚未完成。
命令行/
- 可用于影响模拟 Firebolt 服务器行为的命令行界面
浏览器扩展/
- 可用于影响模拟 Firebolt 服务器行为的浏览器扩展

文档

请参阅文档。

SDK 支持和 server/src/.mf.config.json 文件

Mock Firebolt 是一个非常通用的模拟服务，适用于几乎所有基于 OpenRPC 的服务。服务器运行时支持的特定 SDK 列表由server/src/.mf.config.json文件的内容以及启动服务器时提供的任何关联命令行标志控制。

该存储库包含server/src/.mf.config.SAMPLE.json文件，您需要将此文件复制到server/src/.mf.config.json才能启动服务器。完成此操作后，您可以随意编辑server/src/.mf.config.json文件并根据需要添加其他 SDK。如果您的 API 的 OpenRPC JSON 文件位于云中的某个位置或通过 HTTP 提供，则您应该在此文件中使用 SDK 的url属性，而不是fileName属性（该属性仅用于具有“硬性”属性的 SDK）。 server/package.json文件中的依赖关系”）。

接下来的两节假设您正在使用现成的.mf.config.json文件。

Firebolt SDK 支持

模拟 Firebolt 支持以下 Firebolt SDK： core和management 。

$獾支持

Mock Firebolt 还支持 $badger SDK，以便应用程序开发人员从 $badger 迁移到 Firebolt。

希望激活此功能的开发人员必须在启动 Mock Firebolt 时传递--moneybadger命令行标志。此外，您必须在应用程序中使用activateMockFireboltForBadger.js脚本，并让它在应用程序包（包括 $badger）执行之前执行。

使用情况（本地）

注意：需要 NodeJS 16+。如果您使用nvm ，请nvm use 16或类似值。

安装并运行：

 cd <the place you put your code repos>
git clone https://github.com/rdkcentral/mock-firebolt.git            /* THIS REPO */
cd mock-firebolt

# To start the mock Firebolt server (if running locally)
cd server

# One-time stuff

cp src/.mf.config.SAMPLE.json src/.mf.config.json

# To install dependencies, clean/create build/ subdirectory, build and upgrade SDK, build source code within this project
npm install

# If you want support for Firebolt Core/Manage SDK
# Run in a separate terminal window/tab, or use '&' to background
npm start

# If you need to use non-standard ports for any reason:
npm start -- --httpPort 3456 --socketPort 9876 --wsSessionServerPort 1234

#If you wish to enable conduit functionality*
npm start -- --conduit

*Note*: Requires Conduit to be running. See the Conduit documentation (./conduit/README.md) for more information.

# If you need to use proxy connection for any reason:
npm start -- --proxy <ip>:<port>
Refer more about proxy mode in ./docs/ProxyMode.md

# To use the control CLI (assuming you're in the top-level directory for this repo)
cd cli
npm install
cd src
node cli.mjs --help

# FUTURE: To use the Chrome browser plugin
Visit chrome://extensions in Chrome
Ensure "Developer mode" is turned on (slider to the right in the top right corner of your browser window)
Click the "Load Unpacked" button (top left corner of browser window)
Navigate to the directory under browser-extensions which contains a manifest.json file and click "Select"

现在，您可以通过在 mf.config.SAMPLE 中添加"url": "https://rdkcentral.github.io/firebolt/requirements/latest/specifications/firebolt-open-rpc.json"从 HTTP 访问 core/manage OpenRPC mf.config.SAMPLE.json并复制到mf.config.json 。

使用（如果您愿意，可以通过 Docker）

注意：这些说明当前涉及在本地创建 Docker 映像，而不是从映像存储库下载映像。

 export MF_DOCKER_USER=<yourDockerUsername>

cd <top of repo>

# Create a docker image: Use the appropriate command (most 3rd party app devs should use the first command)
docker build -f Dockerfile.coreSdk . -t $MF_DOCKER_USER/mock-firebolt
docker build -f Dockerfile.allSdks . -t $MF_DOCKER_USER/mock-firebolt

# Confirm your image was created
docker images | grep mock-firebolt

# Run the image, enabling the core/manage OpenRPC (typical)
# Change '$(pwd)' to whatever else you might want to use; this is where your MF .json files live
# NOTE: -p <outside/host port>:<inside/container port>
docker run -d 
  --name mf 
  --mount type=bind,source="$(pwd)",target=/usr/src/firebolt/host-files 
  -p 3333:3333 
  -p 9998:9998 
  $MF_DOCKER_USER/mock-firebolt

# Get container ID
docker ps | grep mf

# See logs
docker logs mf

# Enter the container (if necessary/desired)
docker exec -it mf /bin/bash

# Run CLI commands from inside the container (if necessary/desired)
container> cd /usr/src/firebolt/mock-firebolt/cli/src
container> node cli.mjs --help

# Run CLI
# Note the container path for the volume used when running the image is used here to refer to MF .json files
docker exec -it mf mf.sh --help
docker exec -it mf mf.sh --upload /usr/src/firebolt/host-files/<file relative current directory>
# E.g., docker exec -it mf mf.sh --upload /usr/src/firebolt/host-files/cli/examples/account-1.json

# Cleanup when done
docker stop mf
docker rm mf
docker image rm $MF_DOCKER_USER/mock-firebolt     (If you want to remove the image, too)