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 mf.config.json mf.config.SAMPLE.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)