JUnit Formatter 项目使用教程

JUnit Formatter 项目使用教程

junit-formatterA JUnit XML report exporter for Elixir's ExUnit项目地址:https://gitcode.com/gh_mirrors/ju/junit-formatter

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

JUnit Formatter 是一个用于 Elixir 的 ExUnit 测试框架的 JUnit XML 报告生成器。项目的目录结构如下：

junit-formatter/
├── LICENSE
├── README.md
├── mix.exs
├── mix.lock
├── config/
├── lib/
├── test/
└── github/
    └── workflows/

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• mix.exs: 项目的依赖和配置文件。
• mix.lock: 锁定依赖版本的文件。
• config/: 配置文件目录。
• lib/: 项目的主要代码目录。
• test/: 测试代码目录。
• github/workflows/: GitHub Actions 的工作流配置文件目录。

2. 项目的启动文件介绍

JUnit Formatter 项目的启动文件主要涉及 mix.exs 和 test/test_helper.exs。

mix.exs

mix.exs 文件是 Elixir 项目的核心配置文件，包含了项目的依赖、版本、作者等信息。以下是 mix.exs 文件的部分内容：

defmodule JUnitFormatter.MixProject do
  use Mix.Project

  def project do
    [
      app: :junit_formatter,
      version: "3.4.0",
      elixir: "~> 1.5",
      start_permanent: Mix.env() == :prod,
      deps: deps()
    ]
  end

  defp deps do
    [
      {:junit_formatter, "~> 3.4", only: [:test]}
    ]
  end
end

test/test_helper.exs

test/test_helper.exs 文件用于配置 ExUnit 测试框架。以下是配置 JUnitFormatter 的示例：

ExUnit.configure formatters: [JUnitFormatter, ExUnit.CLIFormatter]
ExUnit.start()

3. 项目的配置文件介绍

JUnit Formatter 的配置文件主要涉及 config/config.exs 和 mix.exs。

config/config.exs

config/config.exs 文件用于配置应用程序的参数。以下是配置 JUnitFormatter 报告文件路径的示例：

import Config

config :junit_formatter, report_file: "test-junit-report.xml"

mix.exs

如前所述，mix.exs 文件包含了项目的依赖和配置信息。以下是添加 JUnitFormatter 依赖的示例：

defp deps do
  [
    {:junit_formatter, "~> 3.4", only: [:test]}
  ]
end

通过以上配置，您可以在运行测试时生成 JUnit 格式的 XML 报告。

junit-formatterA JUnit XML report exporter for Elixir's ExUnit项目地址:https://gitcode.com/gh_mirrors/ju/junit-formatter