Hyperledger Caliper Benchmarks 项目使用教程

1. 项目的目录结构及介绍

Hyperledger Caliper Benchmarks 项目的目录结构如下：

caliper-benchmarks/
├── benchmarks/
│   ├── api/
│   ├── samples/
│   └── scenario/
├── networks/
├── src/
├── .gitignore
├── CODEOWNERS
├── LICENSE
├── MAINTAINERS.md
├── README.md
└── SECURITY.md

目录结构介绍

• benchmarks/: 包含测试配置和回调文件。测试配置文件描述了基准测试的参数，并引用回调文件，这些文件由 Caliper 客户端在基准测试期间执行。

  • api/: 针对单个目标区块链 API 的测试。
  • samples/: 针对目标区块链平台提供的原生示例的测试。
  • scenario/: 适用于所有（支持的）目标区块链平台的通用场景测试。

• networks/: 包含可用于基准测试的目标系统（SUT）的示例区块链网络。

• src/: 包含部署到 SUT 并由测试回调交互的智能合约源文件。每个智能合约都保存在与其对应的区块链技术相关的文件夹中。

• .gitignore: Git 忽略文件。

• CODEOWNERS: 代码所有者文件。

• LICENSE: 项目许可证文件。

• MAINTAINERS.md: 维护者信息文件。

• README.md: 项目介绍和使用说明文件。

• SECURITY.md: 安全相关信息文件。

2. 项目的启动文件介绍

Hyperledger Caliper Benchmarks 项目没有明确的“启动文件”，因为它是用于基准测试的配置和资源集合。要运行基准测试，需要使用 Hyperledger Caliper CLI。

启动步骤

1. 安装 Caliper CLI:

   • 参考 Caliper 主仓库 的安装说明。

2. 克隆本仓库:

   git clone https://github.com/hyperledger/caliper-benchmarks.git
   cd caliper-benchmarks
   

3. 运行基准测试:

   • 使用 Caliper CLI 命令运行基准测试，例如：

     caliper benchmark run --caliper-benchconfig benchmarks/scenario/simple/config.yaml --caliper-networkconfig networks/fabric/fabric-v1.4.1/2org1peergoleveldb/fabric-go.yaml
     

3. 项目的配置文件介绍

配置文件类型

1. 测试配置文件: 位于 benchmarks/ 目录下，描述基准测试的参数。

   • 例如：benchmarks/scenario/simple/config.yaml

2. 网络配置文件: 位于 networks/ 目录下，描述目标区块链网络的配置。

   • 例如：networks/fabric/fabric-v1.4.1/2org1peergoleveldb/fabric-go.yaml

配置文件示例

测试配置文件 (config.yaml)

test:
  name: Simple
  description: This is a simple test
  clients:
    type: local
    number: 5
  rounds:
    - label: init
      txNumber: 10
      rateControl:
        type: fixed-rate
        opts:
          tps: 50
      callback: benchmarks/scenario/simple/init.js

网络配置文件 (fabric-go.yaml)

version: "1.0.0"
name: "Fabric 1.4.1"
description: "Fabric 1.4.1 network"
caliper:
  blockchain: fabric
  command:
    start: scripts/start.sh
    end: scripts/end.sh

通过以上配置文件，可以定义和运行不同的基准测试场景。