开源项目 har2case 使用教程

开源项目 har2case 使用教程

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

har2case 项目的目录结构如下：

har2case/
├── har2case/
│   ├── __init__.py
│   ├── core.py
│   ├── parser.py
│   ├── utils.py
│   └── version.py
├── tests/
│   ├── __init__.py
│   ├── test_core.py
│   ├── test_parser.py
│   └── test_utils.py
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

目录结构介绍

• har2case/: 项目的主目录，包含了项目的核心代码。
  • __init__.py: 初始化文件。
  • core.py: 核心功能实现。
  • parser.py: 解析器实现。
  • utils.py: 工具函数。
  • version.py: 版本信息。
• tests/: 测试目录，包含了项目的单元测试。
  • __init__.py: 初始化文件。
  • test_core.py: 核心功能测试。
  • test_parser.py: 解析器测试。
  • test_utils.py: 工具函数测试。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

项目的启动文件是 setup.py，它负责项目的安装和分发。通过运行以下命令可以安装项目：

pip install .

setup.py 文件的主要内容如下：

from setuptools import setup, find_packages

setup(
    name="har2case",
    version="2.6.8",
    author="debugtalk",
    author_email="mail@debugtalk.com",
    description="Convert HAR(HTTP Archive) to YAML/JSON testcases for HttpRunner.",
    long_description=open("README.md", encoding="utf-8").read(),
    long_description_content_type="text/markdown",
    url="https://github.com/httprunner/har2case",
    packages=find_packages(),
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    python_requires='>=3.6',
    install_requires=[
        "requests",
        "pyyaml",
        "har-parser",
    ],
    entry_points={
        'console_scripts': [
            'har2case=har2case.cli:main',
        ],
    },
)

启动文件介绍

• name: 项目名称。
• version: 项目版本。
• author: 作者信息。
• description: 项目描述。
• long_description: 详细描述，通常从 README.md 文件中读取。
• url: 项目仓库地址。
• packages: 需要包含的包。
• classifiers: 项目分类信息。
• python_requires: 支持的 Python 版本。
• install_requires: 项目依赖。
• entry_points: 命令行入口点。

3. 项目的配置文件介绍

项目中没有显式的配置文件，但可以通过命令行参数进行配置。例如，使用 har2case 命令将 HAR 文件转换为 YAML 或 JSON 格式的测试用例：

har2case input.har -2y output.yml

命令行参数介绍

• input.har: 输入的 HAR 文件。
• -2y: 指定输出格式为 YAML。
• output.yml: 输出的 YAML 文件。

同样，可以使用 -2j 参数指定输出格式为 JSON：

har2case input.har -2j output.json

参数介绍

• -2y: 转换为 YAML 格式。
• -2j: 转换为 JSON