# ios_cov_manager

**Repository Path**: lan-tianyou/ios_cov_manager

## Basic Information

- **Project Name**: ios_cov_manager
- **Description**: ios_cov_manager
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-27
- **Last Updated**: 2025-03-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ios_cov_manager

This is a python project to manage iOS coverage files, including parsing the profraw files and generating lcov files.

# Pre-requirement

- The deployment of the iOS repository should be completed before running the project. The coverage files are generated by the [hdcoverage](https://github.com/erduoniba/hdcoverage) tool.

# Features

- Download the build artifacts and the coverage files uploaded from the build machine to the local machine.
- Extract them to the specified directory under the `data` directory.
- Parse the coverage profraw files into data files and then generate the lcov files.
- Find and copy the files which are not found according to the output of the `xcrun llvm-cov show` command.
- Open the coverage report in a browser.
- Upload the coverage report to the `coverage platform server`.

# How to use

1. You should fill the `user_conf.json.template` file and rename it to `user_conf.json` in your config directory.
2. Deploy the environment.

```bash
bash deploy.sh
```

3. Activate the virtual environment.

```bash
source venv/bin/activate
```

4. Run the project.

```bash
# Example
# {1}: The git url of the iOS project
# {2}: The version of the iOS project in the build
# {3}: The build number of the build
# {4}: The branch name of the iOS project in the build
# {5}: The commit id of the iOS project in the build
# {6}: The path of the iOS project in the build machine, e.g., /Users/Someone/Path/To/The/iOS_repository/
# {7}: Valid options: open_html
python run.py --ios_repo_git_url {1} --version {2} --build_number {3} --branch_name {4} --commit_id {5} --build_machine_repo_path {6} --options {7}
```

- If you have some code files not found while executing the command `xcrun llvm-cov show`, you should add them manually to the `derived_sources` directory and re-run the project

# Reference

- https://github.com/erduoniba/hdcoverage