coveralls-net/coveralls.net

NuGet program for sending coverage reports to coveralls.io

coveralls.net

Coveralls uploader for .Net code coverage reporting

Getting started

Coveralls is a service which keep track of code coverage statistics. The process is as follows:

• Push your code to GitHub
• Build server builds, runs unit tests, and using coveralls.net, sends coverage information to coveralls.io
• Your project's coveralls badge gets updated

For detailed instructions, please visit the wiki

Supported Frameworks

Coverage Tools

• OpenCover
• cobertura XML Format which can also generated by kharma-coverage and kharma-typescript for javascript testing.

CI Services

• AppVeyor
• Jenkins

Planned

These are the current (hopeful) targets, but I'm not sure how far I will be able to get on my own. If you would like to help, please fork this repository

Coverage Tools

• SharpCover
• Mono Code Coverage (monocov)
• Visual Studio Coverage
• NCover

CI Services

• Travis CI
• Bamboo
• TeamCity

Versioning

coveralls.net will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered with the following format:

<major>.<minor>.<build>

and constructed with the following guidelines:

• Breaking backward compatibility bumps the major (resetting the minor and build)
• New additions without breaking backward compatibility bumps the minor (resetting the build)
• Bug fixes and misc changes increase the build number

For more information on SemVer, please visit http://semver.org/.

Bug tracker

Have a bug or a feature request? Please open a new issue. Before opening a new issue, please search for existing issues.

Contributing

Please submit all pull requests against WIP branches. You must include all relevant unit tests for any bug fixes or new features.

Thanks!

Authors

Jason Deering

• http://twitter.com/jasondeering
• http://github.com/jdeering

License

Licensed under the GNU General Public License, Version 3.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License at:

• http://www.gnu.org/licenses/gpl-3.0.txt

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

coveralls.net's Issues

Can't generate coverage files

Can someone please help me this, I'd really appreciate it

C:\projects\covidsharp\CovidSharp\packages\coveralls.io.1.4.2\tools\coveralls.net.exe --opencover coverage.xml --repo-token %COVERALLS_REPO_TOKEN%
coveralls 1.0.6493.21955
Copyright c  2015
ERROR(S):
  Option 'repo-token, r' has no value.

Documentation on usage?

So what I gather from code-cracker issue is that I need to do something similar to this - https://github.com/code-cracker/code-cracker/blob/master/build.targets.ps1#L195-L198

It would be really nice to see some documentation here though.

Source not showing up on coveralls

If you navigate to a source on Coveralls.io you see this:

The file "c:/projects/coveralls-net/Coveralls.Lib/CoverallsBootstrap.cs" isn't available on GitHub. Either it's been removed, or the repo root directory needs to be updated.

Comment on Github Pull Requests

It seems that Coveralls.io is able to comment on PRs from Github, but this library does not yet support it.
I asked the guys at coveralls, and they said the library to implement a few things. Checkout lemurheavy/coveralls-public#429 (comment)
It seems you have to send the PR number: https://coveralls.zendesk.com/hc/en-us/articles/201350799-API-Reference

Error sending to Coveralls.io (422 - Unprocessable Entity

Currently I'm getting the following error message when sending to coveralls.

my configuration is https://github.com/kbilsted/StatePrinter/blob/feature/codecoverage/appveyor.yml

I had it working briefly earlier today but before i encrypted the token. Thus I've generated a new token and encrypted it. There really are no hints as to what is wrong. From the overalls pages I've gathered that it may be lack of environment variables. I've double checked against your example .yml with no success of tracking the problem

Visited Classes 81 of 91 (89.01) 
Visited Methods 288 of 313 (92.01) 
Visited Points 1286 of 1412 (91.08) 
Visited Branches 579 of 671 (86.29) 

==== Alternative Results (includes all methods including those without corresponding source) ==== 
Alternative Visited Classes 95 of 102 (93.14) 
Alternative Visited Methods 358 of 397 (90.18) 
C:\projects\stateprinter\packages\coveralls.io.1.1.86\tools\coveralls.net.exe --opencover coverage.xml
Service: appveyor
 Job ID: mp8v1nv2ygiqpkks
  Files: 48
 Commit: df985b6d56b7d60269545751b202afae37135920
Error sending to Coveralls.io (422 - Unprocessable Entity

1. do you have an idea?
2. can we improve the error message? It looks as though information is being cut off.

Invalid Coveralls Repo Token

Hi I just got started on integrating coverall in my stateprinter project on app appveyor. Unfortunately my log looks like

Committing... 
Visited Classes 81 of 91 (89.01) 
Visited Methods 288 of 313 (92.01) 
Visited Points 1286 of 1412 (91.08) 
Visited Branches 579 of 671 (86.29) 

==== Alternative Results (includes all methods including those without corresponding source) ==== 
Alternative Visited Classes 95 of 102 (93.14) 
Alternative Visited Methods 358 of 397 (90.18) 
C:\projects\stateprinter\packages\coveralls.io.1.1.86\tools\coveralls.net.exe --opencover coverage.xml
Invalid Coveralls Repo Token

I've copied more or less your appveyor.yml file: https://github.com/kbilsted/StatePrinter/blob/feature/codecoverage/appveyor.yml in there i've replaced the security token i got from from https://coveralls.io/r/kbilsted/StatePrinter from the section

If you intend to submit coverage data via a private CI or command line other than Travis Pro, add the following line to your .coveralls.yml :
repo_token: PlKcHlYUjBpsvFEzSnScYzMDseJi9ASNx

I've noticed that this key is significantly shorter than the one you use in your example https://github.com/jdeering/coveralls.net/blob/master/appveyor.yml

I've also noticed that in https://github.com/jdeering/coveralls.net/blob/master/coveralls.net/Program.cs

            if (coveralls.RepoToken.IsBlank())
            {
                Console.WriteLine("Invalid Coveralls Repo Token");
                return;
            }

which is a bit misleading error message.

Any ideas on how to progress?

NRE in 1.4.1

When calling coveralls.net.exe with just the coverage.xml file, the following error occurs:

An unknown exception has occurred.
Object reference not set to an instance of an object.
   at Coveralls.Net.CommandLineOptions.get_InputFiles() in C:\Users\jason\src\open-source\coveralls.net\coveralls.net\CommandLineOptions.cs:line 35
   at Coveralls.CoverallsBootstrap.get_CoverageFiles() in C:\Users\jason\src\open-source\coveralls.net\Coveralls.Lib\CoverallsBootstrap.cs:line 102
   at Coveralls.Net.Program.Run(CommandLineOptions options) in C:\Users\jason\src\open-source\coveralls.net\coveralls.net\Program.cs:line 40
   at Coveralls.Net.Program.Main(String[] args) in C:\Users\jason\src\open-source\coveralls.net\coveralls.net\Program.cs:line 18

This is like #34, I think it was never solved.

The following line https://github.com/coveralls-net/coveralls.net/blob/master/coveralls.net/Program.cs#L17 is most likely calling the default constructor, not setting the _fileSystem as is done in the other constructor here: https://github.com/coveralls-net/coveralls.net/blob/master/coveralls.net/CommandLineOptions.cs#L21

Reporting issue

https://coveralls.io/builds/1971297 is showing as 0% but the coverage is actually 100% - Is there an issue with the upload tool? Are there any switches I can use to dump out what coveralls.net is uploading/sending to coveralls.io?

Application crashes when --commitEmail flag is not supplied

When all flag are in their correct place and all the data is present except --commitEmail, the application crashes (ran it from powershell) using latest stable Nuget package:

PS> Invoke-Expression $cmd
output file 'cov.json' already exists and will be overwritten.

Unhandled Exception: System.NullReferenceException: Object reference not set to an instance of an object.
   at csmacnz.Coveralls.MainArgs.get_OptCommitemail() in c:\projects\coveralls-net\src\csmacnz.Coveralls\T4DocoptNet.cs:
line 84
   at csmacnz.Coveralls.CommandLineGitDataResolver.GenerateData() in c:\projects\coveralls-net\src\csmacnz.Coveralls\Com
mandLineGitDataResolver.cs:line 26
   at csmacnz.Coveralls.Program.<ResolveGitData>b__d(IGitDataResolver p) in c:\projects\coveralls-net\src\csmacnz.Covera
lls\Program.cs:line 182
   at System.Linq.Enumerable.WhereSelectListIterator`2.MoveNext()
   at System.Linq.Enumerable.FirstOrDefault[TSource](IEnumerable`1 source)
   at csmacnz.Coveralls.Program.ResolveGitData(MainArgs args) in c:\projects\coveralls-net\src\csmacnz.Coveralls\Program
.cs:line 182
   at csmacnz.Coveralls.Program.Main(String[] argv) in c:\projects\coveralls-net\src\csmacnz.Coveralls\Program.cs:line 1
18

Cannot upload code coverage: error code 422 even thus token is valid

[debug] > $env.COVERALLS_REPO_TOKEN: << private data >>
Error BadRequest sending to coveralls.io: Bad Request
 - Error code 422 indicate a problem with your token. Use the --debug option for more details.
[debug] > Coveralls Data:

Internal Server 500 error

We have recently just added your tool to the Cake build automation system, and during the uploading of the coverage report, we are getting this error:

https://ci.appveyor.com/project/cakebuild/cake/build/0.16.0-alpha.58.build.2658#L1392

However, the report does seem to get published:

https://coveralls.io/github/cake-build/cake

Do you have any ideas why we would be getting the 500 error?

Thanks!

Build numbers

I would like the coveralls build number to match the one created by AppVeyor. I tried setting the --JobId, like this

packages\coveralls.net.0.6.0\tools\csmacnz.coveralls.exe --opencover -i ./coverage.xml 
   --jobId %APPVEYOR_BUILD_NUMBER%

but it did't work. Here's the yml.

Keep getting the filename, directory name, or volume label syntax is incorrect in appveyor

Trying to get this to work using the instructions here https://github.com/coveralls-net/coveralls.net/wiki/CI-Integrations but it keeps giving an error. More info can be found here https://ci.appveyor.com/project/Barsonax/pathfindax/build/2.2.0.524

The paths are correct but why does it keep giving this error? It even gives this error when I literary copy the text in the instructions.

EDIT: this seems to work properly locally

Support .NET Core

Update the package to support .NET Core usage and be run from dotnet command-line.

Support for Chutzpah coverage (java script)

I'm using visual studio to write my c# code, I also write my web application code with typescript and Chutzpah.
Is it possible to add support for Chutzpah coverage report as well? I think it can write a few output format for coverage as far as I can understand from their wiki:
https://github.com/mmanela/chutzpah/wiki/command-line-options

Add parser - SharpCover

Add support for parsing the file format generated by SharpCover.

Can't find a part of the path

Command line: .\packages\coveralls.io.1.4.2\tools\coveralls.net.exe --opencover .\ReportApiTest.Results.xml -r %COVERALLS_REPO_TOKEN%

Results:

An unknown exception has occurred.
Could not find a part of the path 'C:\projects\moq4\src\Moq\obj\TypeNameFormatter.cs'.
   at System.IO.__Error.WinIOError(Int32 errorCode, String maybeFullPath)
   at System.IO.FileStream.Init(String path, FileMode mode, FileAccess access, Int32 rights, Boolean useRights, FileShare share, Int32 bufferSize, FileOptions options, SECURITY_ATTRIBUTES secAttrs, String msgPath, Boolean bFromProxy, Boolean useLongPath, Boolean checkHost)
   at System.IO.FileStream..ctor(String path, FileMode mode, FileAccess access, FileShare share)
   at System.IO.File.OpenRead(String path)
   at Coveralls.Net.LocalFileSystem.ComputeHash(String path) in C:\Users\jason\src\open-source\coveralls.net\coveralls.net\LocalFileSystem.cs:line 28
   at Coveralls.CoverallsBootstrap.get_CoverageFiles() in C:\Users\jason\src\open-source\coveralls.net\Coveralls.Lib\CoverallsBootstrap.cs:line 124
   at Coveralls.Net.Program.Run(CommandLineOptions options) in C:\Users\jason\src\open-source\coveralls.net\coveralls.net\Program.cs:line 40
   at Coveralls.Net.Program.Main(String[] args) in C:\Users\jason\src\open-source\coveralls.net\coveralls.net\Program.cs:line 18

Appveyor - OpenCover > Coveralls

Hi - I have asked a similar question over at the Open Cover issues page as I am not sure where the problem lies and I was looking for guidance on best practice on this.
The scenario is that we run OpenCover on appveyor on two assemblies with a filter two include only two specific namespaces. Still the output file is over 100mb.
The generated file is then sent with Coveralls.Net to our coveralls.io repo.
The whole process takes about 20 minutes - partly I imagine due to the generation of the output xml partly the sending the large file (+ sources?) to coveralls via coveralls.net.

• what are the options if any on sending less information (I have asked Open Cover for guidance on reducing the size of that file)

• we are using the fork at https://github.com/jdeering/coveralls.net from nuget version 1.25-beta. We updated to 1.3.2 from 1.2.5-beta which gave an error about not finding a value for SourceDigest in the CoverageFile . To get around that we added the option for --full-sources , but then ultimately reverted back to the 1.2.5-beta. Is this a known issue? Again perhaps a question for Open Cover about the output file formatting

  Any help would be appreciated thanks.

Executing command-line throws NRE

I'm getting a NRE when executing in a random folder.

An unknown exception has occurred.
Object reference not set to an instance of an object.
at Coveralls.CoverallsBootstrap.get_CoverageFiles() in c:\projects\coveralls-net-gmbph\Coveralls.Lib\CoverallsBootstrap.cs:line 102
at Coveralls.Net.Program.Run(CommandLineOptions options) in c:\projects\coveralls-net-gmbph\coveralls.net\Program.cs:line 40
at Coveralls.Net.Program.Main(String[] args) in c:\projects\coveralls-net-gmbph\coveralls.net\Program.cs:line 18

Jenkins Support

Just wondering if this supports Jenkins? If so is there any documentation around it?

Thanks

Research and review usage and integration with CI services

• TeamCity (JetBrains)
• Travis CI
• Bamboo (Atlassian)

Review both paid and free continuous integration services and how best to integrate/use the coveralls.net package within them. Some likely support plug-ins, which would be the best solution for everyone.