testmap

Automated C# Test Extraction

https://github.com/consulthunter/testmap

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Automated C# Test Extraction

Basic Info
  • Host: GitHub
  • Owner: consulthunter
  • License: mit
  • Language: C#
  • Default Branch: main
  • Homepage:
  • Size: 241 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 3
  • Releases: 1
Created over 1 year ago · Last pushed 11 months ago
Metadata Files
Readme License Citation

README.md

TestMap

DOI License Language

TestMap is a tool for gathering software tests from C# repositories from GitHub and other Git based developer platforms.

It collects software tests using SyntaxTrees and the Roslyn API.

Dependencies

  • Windows 11
  • .NET SDK 9.0 or greater
    • Instructions
    • (winget is suggested)
      • winget install Microsoft.DotNet.SDK.9

Note: dotnet needs to be on PATH. Make sure that dotnet --version works through the CLI

Installation

Create a directory, named Projects. - mkdir Projects

Navigate to the Projects directory. - cd .\Projects\

Create a directory, named TestMap. - mkdir TestMap

Navigate to the TestMap directory. - cd TestMap

Download and Extract the latest release.

Change into the Release directory: - cd Release

Generate the config: - .\TestMap.exe generate-config --path D:\Projects\TestMap\TestMap\Config\new-config.json --base-path D:\Projects\TestMap - Note: Replace D:\Projects with your directory prefix.

Next try running the project: - .\TestMap.exe collect --config D:\Projects\TestMap\TestMap\Config\new-config.json - Note: Update the path to the generated config.

If this didn't work, try building and publishing yourself. See Building.

Building And Publishing

More details on building and publishing the tool for use here.

How To Use

More details on how to use this tool is available here.

Testing

Unit tests for TestMap are generally run through GitHub Actions.

Integration tests typically need to be done locally.

For details on testing you can find more information here.

How It Works

Technical detail on how the tool works is available here.

Future Work

We have some ideas for future work located here.

Owner

  • Name: Hunter
  • Login: consulthunter
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Leary
    given-names: Hunter
    orcid: https://orcid.org/0009-0008-1056-8106
title: "TestMap"
version: 1.0.0
identifiers:
  - type: doi
    value: 10.5281/zenodo.14262975
date-released: 2024-12-02

GitHub Events

Total
  • Create event: 6
  • Release event: 2
  • Issues event: 10
  • Delete event: 5
  • Public event: 1
  • Push event: 16
  • Pull request event: 8
Last Year
  • Create event: 6
  • Release event: 2
  • Issues event: 10
  • Delete event: 5
  • Public event: 1
  • Push event: 16
  • Pull request event: 8

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 1
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 1 minute
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 1
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 1 minute
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • consulthunter (4)
Pull Request Authors
  • consulthunter (4)
Top Labels
Issue Labels
enhancement (2) documentation (2)
Pull Request Labels
documentation (1)

Dependencies

.github/workflows/dotnet.yml actions
  • actions/checkout v4 composite
  • actions/setup-dotnet v4 composite
TestMap/TestMap.csproj nuget
  • coverlet.collector 6.0.2 development
  • xunit.runner.visualstudio 2.8.2 development
  • CommandLineParser 2.9.1
  • CsvHelper 33.0.1
  • LibGit2Sharp 0.30.0
  • Microsoft.Build 17.12.6
  • Microsoft.Build.Locator 1.7.8
  • Microsoft.CodeAnalysis.CSharp 4.11.0
  • Microsoft.CodeAnalysis.CSharp.Workspaces 4.11.0
  • Microsoft.CodeAnalysis.Workspaces.MSBuild 4.11.0
  • Microsoft.Extensions.Configuration 8.0.0
  • Microsoft.Extensions.Configuration.Json 8.0.1
  • Microsoft.Extensions.Hosting 8.0.1
  • Microsoft.Extensions.Logging 8.0.1
  • Microsoft.PowerShell.Commands.Diagnostics 7.4.6
  • Microsoft.PowerShell.Commands.Management 7.4.6
  • Microsoft.PowerShell.Commands.Utility 7.4.6
  • Microsoft.PowerShell.ConsoleHost 7.4.6
  • Microsoft.PowerShell.Native 7.4.0
  • Microsoft.WSMan.Management 7.4.6
  • Moq 4.20.72
  • Serilog 4.1.0
  • Serilog.Sinks.File 6.0.0
  • System.Diagnostics.PerformanceCounter 8.0.1
  • System.Formats.Asn1 8.0.1
  • System.Management 8.0.0
  • System.Management.Automation 7.4.6
  • System.Text.Json 8.0.5
TestMap.Tests/TestMap.Tests.csproj nuget
  • coverlet.collector 6.0.2 development
  • xunit.runner.visualstudio 2.8.2 development
  • CommandLineParser 2.9.1
  • JetBrains.Annotations 2024.3.0
  • LibGit2Sharp 0.30.0
  • Microsoft.Extensions.Configuration 8.0.0
  • Microsoft.Extensions.Configuration.Json 8.0.1
  • Microsoft.Extensions.Hosting 8.0.1
  • Microsoft.NET.Test.Sdk 17.11.1
  • Moq 4.20.72
  • System.Formats.Asn1 8.0.1
  • System.Text.Json 8.0.5
  • xunit 2.9.2