{"id":16683234,"url":"https://github.com/replaysmike/nunit.extension.testmonitor","last_synced_at":"2025-06-15T15:32:54.196Z","repository":{"id":45849418,"uuid":"239893678","full_name":"replaysMike/NUnit.Extension.TestMonitor","owner":"replaysMike","description":"Provides realtime test monitoring functionality to NUnit","archived":false,"fork":false,"pushed_at":"2022-12-08T14:55:41.000Z","size":1838,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-10T15:19:49.255Z","etag":null,"topics":["csharp","nunit","nunit3","testing"],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/replaysMike.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-12T00:28:29.000Z","updated_at":"2021-12-02T06:09:39.000Z","dependencies_parsed_at":"2023-01-25T14:00:59.116Z","dependency_job_id":null,"html_url":"https://github.com/replaysMike/NUnit.Extension.TestMonitor","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/replaysMike%2FNUnit.Extension.TestMonitor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/replaysMike%2FNUnit.Extension.TestMonitor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/replaysMike%2FNUnit.Extension.TestMonitor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/replaysMike%2FNUnit.Extension.TestMonitor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/replaysMike","download_url":"https://codeload.github.com/replaysMike/NUnit.Extension.TestMonitor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243402730,"owners_count":20285290,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csharp","nunit","nunit3","testing"],"created_at":"2024-10-12T14:23:53.041Z","updated_at":"2025-03-13T12:24:21.708Z","avatar_url":"https://github.com/replaysMike.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NUnit.Extension.TestMonitor\n[![nuget](https://img.shields.io/nuget/v/NUnit.Extension.TestMonitor.svg)](https://www.nuget.org/packages/NUnit.Extension.TestMonitor/)\n[![nuget](https://img.shields.io/nuget/dt/NUnit.Extension.TestMonitor.svg)](https://www.nuget.org/packages/NUnit.Extension.TestMonitor/)\n[![Build status](https://ci.appveyor.com/api/projects/status/6vxd3cq83kuo4hg1?svg=true)](https://ci.appveyor.com/project/MichaelBrown/NUnit.Extension.TestMonitor)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/a79c138869504a359a064a98aa74908a)](https://www.codacy.com/app/replaysMike/NUnit.Extension.TestMonitor?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=replaysMike/NUnit.Extension.TestMonitor\u0026amp;utm_campaign=Badge_Grade)\n[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/a79c138869504a359a064a98aa74908a)](https://www.codacy.com/app/replaysMike/NUnit.Extension.TestMonitor?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=replaysMike/NUnit.Extension.TestMonitor\u0026utm_campaign=Badge_Coverage)\n\nProvides realtime test monitoring functionality to NUnit using IPC/Named Pipes, Grpc, log files, or StdOut.\n\n# Installation\n\nChoose which configuration you would like to use: [NUnit-Console](https://github.com/nunit/nunit-console) runner or `dotnet test`. See below for installation/configuration instructions for either way of running tests.\n\n## Configuration\n\nThis extension is compatible with both the [NUnit-Console](https://github.com/nunit/nunit-console) runner as well as when using `dotnet test` however they must be configured differently. Keep in mind NUnit-Console runner does not currently support .Net Core testing, if you need that you should use the `dotnet test` configuration.\n\n### NUnit-Console Configuration\n\nIf using the [NUnit-Console](https://github.com/nunit/nunit-console) runner you must place the extension inside the `addins/` folder of the installation location of NUnit-Console. [Download](https://github.com/replaysMike/NUnit.Extension.TestMonitor/releases) the latest pre-compiled release. The `addins/` folder of NUnit-Console should already exist in its installation folder, and you should place the extension dll's in it's own folder called `NUnit.Extension.TestMonitor`. Additionally, you must tell NUnit-Console of it's existence by appending to the `nunit.bundle.addins` file with the following contents:\n\n```\naddins/NUnit.Extension.TestMonitor/NUnit.Extension.TestMonitor.dll      # Include the TestMonitor nUnit extension\n```\nIf you wish to customize the extension with non-default options (such as enabling file based logging) you can edit the settings file which will be located at `addins/NUnit.Extension.TestMonitor/appsettings.json`.\n\nTo confirm that your extension is recognized, you can check with the console runner using: `nunit3-console.exe --list-extensions`\n\n### Dotnet Test Configuration\n\nIf using the `dotnet test` command to run your tests you should add the Nuget package to your test project. \n\n```\nPM\u003e Install-Package NUnit.Extension.TestMonitor\n```\n\nTo customize settings for the extension, you can add an `appsettings.json` configuration file to your test project and it will be read by the nuget extension. It should contain the following section in the root of your settings file:\n\n```\n{\n  \"TestMonitor\": {\n    // the type of events to emit, can define multiple. Valid options: NamedPipes,Grpc,StdOut,LogFile\n    \"EventEmitType\": \"Grpc,StdOut,LogFile\",\n    // format of the event data. Valid options: json, xml\n    \"EventFormat\": \"json\",\n    // full path to save the log to\n    \"EventsLogFile\": \"C:\\\\logs\\\\TestMonitor.log\",\n    // for EventEmitType=StdOut, choose which stream to use. Valid options: StdOut, Trace, Debug, None\n    \"EventOutputStream\": \"StdOut\",\n    // The timeout (in milliseconds) to wait for a Named Pipe client connection (when using EventEmitType=NamedPipes)\n    \"NamedPipesConnectionTimeoutMilliseconds\": 2000,\n    // grpc port number to send test events to (when using EventEmitType=Grpc)\n    \"Port\": 35001,\n    // specify which launchers the extension will work for. If tests are launched by other launchers, the extension will disable waiting for connections. Default: NUnit.Commander.exe\n    \"SupportedRunnerExe\": \"NUnit.Commander.exe\"\n  }\n}\n```\n\n# Usage\n\nThis plugin offers both an IPC/Named Pipes or Grpc support so that you may display or log tests in real-time via a supported real-time client. Any IPC or Grpc host that can receive the json/xml/binary formatted events can receive test information in real-time for analysis and logging.\n\nIt is recommended to use the free [NUnit-Commander](https://github.com/replaysMike/NUnit.Commander) as your real-time monitoring client.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freplaysmike%2Fnunit.extension.testmonitor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freplaysmike%2Fnunit.extension.testmonitor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freplaysmike%2Fnunit.extension.testmonitor/lists"}