feat: setup, action, characterization testing #1
Conversation
DavSanchez
force-pushed
the
refactor/review-code
branch
from
483a655 to
50e2d12
Compare
DavSanchez
changed the title
You're totally right. I'm adding a README xD |
DavSanchez
force-pushed
the
refactor/review-code
branch
from
c5ff159 to
d06ff82
Compare
DavSanchez
changed the title
Co-authored-by: Christian <sigilioso@gmail.com>
DavSanchez
force-pushed
the
refactor/review-code
branch
2 times, most recently
from
ae0f6f8 to
95caf40
Compare
DavSanchez
force-pushed
the
refactor/review-code
branch
from
95caf40 to
d2865a6
Compare
Cargo.toml
Outdated
| missing_docs = "warn" | ||
|
|
||
| [lints.clippy] | ||
| missing_docs_in_private_items = "warn" |
There was a problem hiding this comment.
Fixed in 947f845!
README.md
Outdated
There was a problem hiding this comment.
As discussed, let's check if this should follow this template
.github/workflows/tests.yml
Outdated
| with: | ||
| submodules: true | ||
| - name: Install stable | ||
| uses: dtolnay/rust-toolchain@1.85.0 |
There was a problem hiding this comment.
would make sense to pin latest stable?
There was a problem hiding this comment.
I think it does. Changed in 9401fce!
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | ||
| cancel-in-progress: true | ||
| name: ⚖️ Third party licenses |
There was a problem hiding this comment.
Could you describe in the name what is the worklfow doing? i was expecting one of them testing the action itself like self test with some asserts that, kind of a action integration test
| } | ||
|
|
||
| #[test] | ||
| fn golden() { |
There was a problem hiding this comment.
here is the test i mentioned in the previous comment :) , so perhaps run it on the workflows by using the action too?
There was a problem hiding this comment.
Yes! This is implemented in the second PR: #2
I can merge it into this one, but I wanted to keep it separate because it rewrote the code from its previous state in AC, so it was easier to review.
This PR includes much more content than I planned initially, but will leave the repo in an acceptable "first state" for use.
Repo structure
Adds a
README.mdand the usual contents of NR Open Source repos.GitHub Actions
This repo becomes usable as a GitHub Action, for consumption in our intended repositories.
Characterization testing
The contents of the
goldentest crate help to make sure no modification of this crate break how this template is generated.There are two files in the
fixturesdirectory:cargo_deny_output.jsonrepresents the output of runningcargo deny --all-features --manifest-path ./Cargo.toml list -l crate -f jsoninside the root directory of thenewrelic-oauth-client-rsrepository, at a certain revision. The tooling versions used are:cargo1.85.0cargo-deny0.16.3expected_third_party_notices_file.mdis a third party notices file, as generated from the previous JSON contents passed throughrust-licenses-noticerin a known previous state. Specifically, before the crate was moved to this repository, with the template tailored tonewrelic-oauth-client-rs.Any change on
rust-licenses-noticerthat breaks how the notices file is generated will be caught here.