json schema for `errored` does not parallel that of `passing` and `failing`

[sei-shissam]

Describe the bug
There is no name key for errored as there is for passing and failing

When parsing the resulting json from a hc check analyzing those analyzes that pass, fail, and error are not similar.

To Reproduce

• Get the results for a hc check and save those results to a file

hc --format json check https://github.com/mitre/hipcheck > sample.json

• Now observe queries of that json result

$ jq -r '.passing[]|.name' sample.json
mitre/activity
mitre/entropy
mitre/churn
mitre/identity
mitre/binary
$ jq -r '.failing[]|.name' sample.json
mitre/fuzz
mitre/review
mitre/affiliation
$ jq -r '.errored[]|.name' sample.json
null

• observe that null for errored is incorrect in this case as there is no key name in the errored structure

• observe that the name of the errored analysis is in the key analysis

$ jq -r '.errored[]|.analysis' sample.json
mitre/typo

Expected behavior
the errored analyzes would follow the same pattern for the others (i.e., passing and failing)

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• Operating System: [e.g. macOS] Ubuntu 22.04
• Hipcheck Version [e.g. 3.6.0] 3.13.0

Additional context
As an aside, the key analysis for those three structures do not appear distinct in any manner and now sure if this is intended or not (perhaps for future use).

$ jq -r '.errored[]|.analysis' sample.json
mitre/typo
$ jq -r '.failing[]|.analysis' sample.json
Analysis
Analysis
Analysis
$ jq -r '.passing[]|.analysis' sample.json
Analysis
Analysis
Analysis
Analysis
Analysis

[alilleybrinker]

Thanks for the report! We're in a maintenance mode right now and have very limited capacity to handle bugs, but I can try to take a look. Should hopefully be an easy fix.

[sei-shissam]

I’m willing to do a PR for this change if you think y’all would be willing to entertain a few questions should I come across any points I need clarification on. Your call. b/r scott

[alilleybrinker]

Absolutely! Yes, happy to answer any questions you may have along the way. Thanks!

[sei-shissam]

Perfect – I estimate a week’ish or so before I can start Cheers!

[sei-shissam]

Perfect – I estimate a week’ish or so before I can start

Cheers!

I am posting this here - it may help others or show other how much I have to learn

I appear to be at an impasse,

• cargo install hipcheck only gets me to 3.7.0,
• cargo install --version 3.13.0 hipcheck fails as the cargo repo only sees up to 3.7.0, and,
• git clone ... cd hipcheck; cargo install --path hipcheck fails with a rustc error about RUSTVERSION and an unfound file called version.expr

here are the details: (I must be doing something wrong)

tool chain

cargo --version; rustc --version ; rustup --version; protoc --version; mold --version; cat /etc/lsb-release 
cargo 1.86.0 (adf9b6ad1 2025-02-28)
rustc 1.86.0 (05f9846f8 2025-03-31)
rustup 1.28.1 (f9edccde0 2025-03-05)
info: This is the version for the rustup toolchain manager, not the rustc compiler.
info: The currently active `rustc` version is `rustc 1.86.0 (05f9846f8 2025-03-31)`
libprotoc 3.12.4
mold 1.0.3 (compatible with GNU ld)
DISTRIB_ID=Ubuntu
DISTRIB_RELEASE=22.04
DISTRIB_CODENAME=jammy
DISTRIB_DESCRIPTION="Ubuntu 22.04.5 LTS"

quick install from source

$ cargo install hipcheck
# pulls 3.7.0 - I'd like 3.13.0
...
   Compiling git2 v0.19.0
    Finished `release` profile [optimized] target(s) in 12m 37s
  Installing /home/vagrant/.cargo/bin/hc
   Installed package `hipcheck v3.7.0` (executable `hc`)
$ /home/vagrant/.cargo/bin/hc --version
Hipcheck 3.7.0
$ /home/vagrant/.cargo/bin/hc check https://github.com/cmu-sei/threat-hunting-games
           Analyzing GitHub repo cmu-sei/threat-hunting-games from https://github.com/cmu-sei/threat-hunting-games
failed to run npm, make sure npm is in the PATH and installed
                    cannot find binary path
(ugggghhhh need to install npm - instructions (how much?)

quick install from source with latest version

$ cargo install --version 3.13.0 hipcheck
    Updating crates.io index
error: could not find `hipcheck` in registry `crates-io` with version `=3.13.0`
$ $ cargo search hipcheck
hipcheck = "3.7.0"               # Automatically assess and score software packages for supply chain risk. 
hipcheck-sdk = "0.6.0"           # SDK for writing Hipcheck plugins in Rust
hipcheck-macros = "0.3.4"        # Helper macros for the `hipcheck` crate.
hipcheck-common = "0.4.1"        # Common functionality for the Hipcheck gRPC protocol
hipcheck-sdk-macros = "0.2.0"    # Helper macros for the `hipcheck-sdk` crate.
pathbuf = "1.0.0"                # A macro to conveniently build PathBufs

install from git source for changing

# clone hipcheck
$ cd hipcheck
$ cargo install --path hipcheck
$ cargo install --path hipcheck
  Installing hipcheck v3.13.0 (/data/src/hipcheck/hipcheck)
    Updating crates.io index
...
   Compiling anyhow v1.0.98
   Compiling stable_deref_trait v1.2.0
error: couldn't read `/data/src/hipcheck/target/release/build/rustversion-838a51247822adb4/out/version.expr`: No such file or directory (os error 2)
   --> /home/vagrant/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/rustversion-1.0.20/src/lib.rs:217:30
    |
217 | const RUSTVERSION: Version = include!(concat!(env!("OUT_DIR"), "/version.expr"));
    |                              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
    = note: this error originates in the macro `include` (in Nightly builds, run with -Z macro-backtrace for more info)

error: could not compile `rustversion` (lib) due to 1 previous error
warning: build failed, waiting for other jobs to finish...
error: failed to compile `hipcheck v3.13.0 (/data/src/hipcheck/hipcheck)`, intermediate artifacts can be found at `/data/src/hipcheck/target`.
To reuse those artifacts with a future compilation, set the environment variable `CARGO_TARGET_DIR` to that path.

[alilleybrinker]

Yeah, we stopped publishing binary releases of the Hipcheck crate to Crates.io after version 3.7.0 (see the RFD for it). It looks like we failed to fully update the install instructions, as they still refer to running cargo install. Apologies for that! I can open an issue for it.

As for the build issue, that I'm less sure about. What version of rustc are you running?

[sei-shissam]

Yeah, we stopped publishing binary releases of the Hipcheck crate to Crates.io after version 3.7.0 (see the RFD for it). It looks like we failed to fully update the install instructions, as they still refer to running cargo install. Apologies for that! I can open an issue for it.

As for the build issue, that I'm less sure about. What version of rustc are you running?

cargo --version; rustc --version ; rustup --version; protoc --version; mold --version; cat /etc/lsb-release 
cargo 1.86.0 (adf9b6ad1 2025-02-28)
rustc 1.86.0 (05f9846f8 2025-03-31)
rustup 1.28.1 (f9edccde0 2025-03-05)
info: This is the version for the rustup toolchain manager, not the rustc compiler.
info: The currently active `rustc` version is `rustc 1.86.0 (05f9846f8 2025-03-31)`
libprotoc 3.12.4
mold 1.0.3 (compatible with GNU ld)
DISTRIB_ID=Ubuntu
DISTRIB_RELEASE=22.04
DISTRIB_CODENAME=jammy
DISTRIB_DESCRIPTION="Ubuntu 22.04.5 LTS"

[sei-shissam]

Yeah, we stopped publishing binary releases of the Hipcheck crate to Crates.io after version 3.7.0 (see the RFD for it). It looks like we failed to fully update the install instructions, as they still refer to running cargo install. Apologies for that! I can open an issue for it.

As for the build issue, that I'm less sure about. What version of rustc are you running?

wave off please... I was able to successfully build hipcheck v3.13.0 on two other systems - something must be wrong with the original system I tried this on. So this is not a problem with the instructions for building from git source