XcodeSelectiveTesting 项目教程

XcodeSelectiveTesting 项目教程

XcodeSelectiveTesting Xcode selective testing: Run only tests relevant to the changeset. 项目地址: https://gitcode.com/gh_mirrors/xc/XcodeSelectiveTesting

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

XcodeSelectiveTesting 项目的目录结构如下：

XcodeSelectiveTesting/
├── github/workflows/
│   └── xcode-selective-testing.yml
├── Plugins/SelectiveTestingPlugin/
│   ├── SelectiveTestingPlugin.swift
│   └── ...
├── Sources/
│   ├── Main.swift
│   └── ...
├── Tests/
│   ├── TestMain.swift
│   └── ...
├── .gitignore
├── ACKNOWLEDGEMENTS
├── CODE_OF_CONDUCT.md
├── LICENSE
├── Package.resolved
├── Package.swift
├── README.md
├── install.sh
├── selective-testing-config-example.yml
├── spm-artifact-bundle-info.template
└── spm-artifact-bundle.sh

目录结构介绍

• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• Plugins/SelectiveTestingPlugin/: 包含选择性测试插件的源代码。
• Sources/: 包含项目的主要源代码文件。
• Tests/: 包含项目的测试代码文件。
• .gitignore: Git 忽略文件配置。
• ACKNOWLEDGEMENTS: 感谢声明文件。
• CODE_OF_CONDUCT.md: 行为准则文件。
• LICENSE: 项目许可证文件。
• Package.resolved: Swift Package Manager 的依赖解析文件。
• Package.swift: Swift Package Manager 的包配置文件。
• README.md: 项目介绍和使用说明文件。
• install.sh: 安装脚本文件。
• selective-testing-config-example.yml: 选择性测试配置示例文件。
• spm-artifact-bundle-info.template: Swift Package Manager 的工件包信息模板文件。
• spm-artifact-bundle.sh: Swift Package Manager 的工件包脚本文件。

2. 项目的启动文件介绍

项目的启动文件是 Sources/Main.swift。该文件是项目的主入口点，负责初始化项目并启动主要功能。

Main.swift 文件内容示例

import Foundation

print("XcodeSelectiveTesting 项目已启动")

// 初始化项目配置
let config = Configuration()

// 启动选择性测试功能
let selectiveTesting = SelectiveTesting(config: config)
selectiveTesting.run()

3. 项目的配置文件介绍

项目的配置文件主要包括 Package.swift 和 selective-testing-config-example.yml。

Package.swift 文件内容示例

// swift-tools-version:5.8
import PackageDescription

let package = Package(
    name: "XcodeSelectiveTesting",
    platforms: [
        .macOS(.v12)
    ],
    products: [
        .executable(
            name: "xcode-selective-test",
            targets: ["XcodeSelectiveTesting"]
        )
    ],
    dependencies: [
        .package(url: "https://github.com/apple/swift-argument-parser", from: "1.0.0"),
        .package(url: "https://github.com/tuist/XcodeProj", from: "8.5.0")
    ],
    targets: [
        .target(
            name: "XcodeSelectiveTesting",
            dependencies: [
                .product(name: "ArgumentParser", package: "swift-argument-parser"),
                .product(name: "XcodeProj", package: "XcodeProj")
            ]
        ),
        .testTarget(
            name: "XcodeSelectiveTestingTests",
            dependencies: ["XcodeSelectiveTesting"]
        )
    ]
)

selective-testing-config-example.yml 文件内容示例

basePath: "./"
testPlan: "Tests/TestPlan.xctestplan"
exclude:
  - "Tests/ExcludedTests"
extra:
  dependencies:
    - name: "MainApp"
      dependsOn: ["LoginUI"]
  targetsFiles:
    - name: "MainApp"
      files: ["Sources/MainApp/**"]

配置文件介绍

• Package.swift: 定义了项目的依赖关系、目标和产品。
• selective-testing-config-example.yml: 定义了选择性测试的配置，包括基础路径、测试计划、排除的测试目录以及额外的依赖关系和目标文件。

通过以上配置文件，可以灵活地调整项目的依赖关系和测试策略，确保项目在不同环境下都能正常运行和测试。

XcodeSelectiveTesting Xcode selective testing: Run only tests relevant to the changeset. 项目地址: https://gitcode.com/gh_mirrors/xc/XcodeSelectiveTesting