Download and run cargo-tarpaulin from GitHub releases #1

garyttierney · 2019-09-18T14:45:51Z

This is mostly a draft right now, but should be fully functioning (though you'll have to invoke cargo tarpaulin yourself, this action is only installing it right now). Some things still to do:

Generate dist/index.js, only sources are in here now (maybe we add a pre-commit hook for this)
Check for missing cargo-tarpaulin versions (if someone requests an invalid version, we should be able to identify that)
Resolve the latest version to the current GitHub release.
Actually run cargo-tarpaulin as part of the action.
Pass user supplied options through to tarpaulin.

We're using the version that is published to tarpaulins GitHub releases page instead of pulling it from crates.io. This cuts a considerable amount of runtime off of the job (10m vs 1-5s). This works because the GitHub actions virtual environment is identical (for all intents and purposes, they're both using Ubuntu latest) to the environment that tarpaulin is being built in.

svartalf

So, I dropped a few thoughts and ideas, they are not mandatory, but either worth to add or at least could be discussed.

svartalf · 2019-10-28T21:20:24Z

README.md

-
-As `rustup` is not installed by default for [macOS environments](https://help.github.com/en/articles/virtual-environments-for-github-actions)
-at the moment (2019-09-13), this Action will try its best to install it before any other operations.
+* `version`: The version of `cargo-tarpaulin` that will be installed.


Would be nice to make the inputs table, same as you suggested for actions-rs/cargo and other Actions.

svartalf · 2019-10-28T21:21:53Z

README.md

+* `version`: The version of `cargo-tarpaulin` that will be installed.
+* `run-types`: The type of tests to run (`Tests`, or `Doctests`). Runs all by default. May be overridden by `args`.
+* `timeout`: The timeout, in seconds, before cancelling execution of a long running test. May be overriden by `args`.
+* `tarpaulin-args`: Extra command line arguments that are passed to `cargo-tarpaulin`.


Could it be renamed to args in order to be the same as actions-rs/cargo args input? By making it consistent we could provide a better experience for users.

Nope, afraid not. I'd already tried this. It seems like args is hijacked by the actions runtime (for the purpose of passing it to containers).

I mean, it works for actions-rs/cargo somehow.
Maybe it should be declared in action.yml too in order to be used?

svartalf · 2019-10-28T21:25:48Z

README.md

-at the moment (2019-09-13), this Action will try its best to install it before any other operations.
+* `version`: The version of `cargo-tarpaulin` that will be installed.
+* `run-types`: The type of tests to run (`Tests`, or `Doctests`). Runs all by default. May be overridden by `args`.
+* `timeout`: The timeout, in seconds, before cancelling execution of a long running test. May be overriden by `args`.


From what I understand, run-types and timeout are most used arguments for tarpaulin executable? Not sure if it worth to put them as a separate inputs. actions-rs/grcov is using a separate config file, as the grcov has a lot of flags and options to tune, but I now think that it was a bad idea and it should probably just use the args input.

I would love to hear your thoughts about it, as it is not clear for me, how should such Actions behave at all.

I'm not 100% sure about this, but I'm going to have a think about it. I think there's some cases where a "user friendly" option could be better, but then maybe the best place for that is in the upstream package.

Coming back to this, I think allowing an args input and special casing some of the more common inputs makes sense (to make them more visible where a program has a lot of options). Otherwise, we'd need to keep adding new inputs to the config file as the programs grow more features and options.

svartalf · 2019-10-28T21:27:09Z

README.md

+      - name: Upload to codecov.io
+        uses: codecov/codecov-action@v1.0.2
+        with:
+          token: ${{secrets.CODECOV_TOKEN}}


Kinda unclear how does tarpaulin-generated file is read by codecov Action?
It seems that tarpaulin generates file at ./cobertura.xml and codecov-action is using the same path by default, but it is unobvious, could we add them explicitly?

The codecov action just scans all files in the cwd (using find and grep) to identify coverage files, so you don't have to match up paths. Tarpaulin currently doesn't have an option for the output path AFAIK.

svartalf · 2019-10-28T21:28:13Z

action.yml

+    description: 'The type of the coverage run [possible values: Tests, Doctests]'
+    required: false
+
+  github-release-endpoint:


What are the cases when this input could be used?

Local testing only when I want to mock the GitHub API, maybe it should be something other than an input.

svartalf · 2019-10-28T21:32:41Z

src/main.ts

+        args.push('--timeout', config.timeout);
+    }
+
+    additionalArgs.forEach(item => args.push(item));


It is not like I am a JS/TS expert, but should not the args = args.concat(additionalArgs) do the same thing?

svartalf · 2019-10-29T08:01:40Z

.gitignore

+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser


All the IDE-related stuff should go to your global gitignore probably, as it seems unreasonable to maintain the same ignore lists for all IDE used for each repo

svartalf · 2019-10-29T08:05:36Z

src/config.ts

+    let additionalOptions: string[] = [];
+
+    if (input.opts !== null) {
+        let opts = input.opts.match(/[^\s]+|"(?:\\"|[^"])+"/g);


I used string-argv npm package to parse CLI arguments string in actions-rs/cargo, we could use it here too, as it should handle any edge cases better

JP-Ellis · 2019-12-05T03:46:46Z

Any update on this pull request? It would be very helpful to have this 👍 (if I get time, I might be able to help in a couple of weeks if this is still pending).

djc · 2020-01-03T20:19:37Z

Hey @svartalf, could you re-review? Would be great to have this!

svartalf · 2020-01-13T13:28:58Z

https://github.com/marketplace/actions/rust-tarpaulin 🎉

Download cargo-tarpaulin from GitHub releases

043c36d

svartalf mentioned this pull request Sep 19, 2019

Tracking issue for Tarpaulin Action actions-rs/meta#2

Closed

Run cargo-tarpaulin with support for options

4daad73

garyttierney force-pushed the feat/draft-version branch from 068549d to 4daad73 Compare September 20, 2019 20:17

Add simple action inputs test

2441bf6

garyttierney force-pushed the feat/draft-version branch from df7c5c1 to 2441bf6 Compare September 20, 2019 20:31

Use @actions/tool-cache instead of download package

1626a4b

garyttierney changed the title ~~Download cargo-tarpaulin from GitHub releases~~ Download and run cargo-tarpaulin from GitHub releases Sep 21, 2019

garyttierney added 5 commits September 24, 2019 21:00

Get cargo from @actions-rs/core

a78bd7a

Use @actions-rs/core to get input

08a981c

Remove debug log statement

2fc4961

Attempt to authenticate with GitHub

abf4d91

Allow specifying extra command line arguments

f75a8fb

garyttierney force-pushed the feat/draft-version branch from 33e1876 to f75a8fb Compare October 22, 2019 23:09

svartalf suggested changes Oct 29, 2019

View reviewed changes

svartalf mentioned this pull request Nov 27, 2019

Caching tracking issue actions-rs/meta#21

Open

garyttierney added 5 commits December 7, 2019 21:41

Rename 'tarpaulin-args' input to 'args'

045c68a

Make github-release-endpoint an env var

5d7d41e

Parse additional arguments with string-argv

bbc26d7

Fix tests and rebuild

4dc7bf1

Re-format inputs in README to a table

2f413d0

svartalf merged commit 1cf9e52 into actions-rs:dev Jan 13, 2020

garyttierney deleted the feat/draft-version branch January 14, 2020 10:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Download and run cargo-tarpaulin from GitHub releases #1

Download and run cargo-tarpaulin from GitHub releases #1

garyttierney commented Sep 18, 2019 •

edited

Loading

svartalf left a comment

svartalf Oct 28, 2019

svartalf Oct 28, 2019

garyttierney Oct 29, 2019

svartalf Oct 29, 2019

svartalf Oct 28, 2019

garyttierney Oct 29, 2019

garyttierney Dec 7, 2019

svartalf Oct 28, 2019

garyttierney Dec 7, 2019

svartalf Oct 28, 2019

garyttierney Oct 29, 2019

svartalf Oct 28, 2019

svartalf Oct 29, 2019

svartalf Oct 29, 2019

JP-Ellis commented Dec 5, 2019

djc commented Jan 3, 2020

svartalf commented Jan 13, 2020

Download and run cargo-tarpaulin from GitHub releases #1

Download and run cargo-tarpaulin from GitHub releases #1

Conversation

garyttierney commented Sep 18, 2019 • edited Loading

svartalf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JP-Ellis commented Dec 5, 2019

djc commented Jan 3, 2020

svartalf commented Jan 13, 2020

garyttierney commented Sep 18, 2019 •

edited

Loading