Debug bundle (#66)

Author: jssblck

.cargo/config.toml

@@ -1,2 +1,5 @@
 [registries.crates-io]
 protocol = "sparse"
+
+[target.x86_64-pc-windows-gnu]
+linker = "x86_64-w64-mingw32-gcc"

.github/workflows/dynamic-analysis.yml

@@ -9,16 +9,23 @@ jobs:
       matrix:
         include:
         - os: ubuntu-latest
+          toolchain: stable
         - os: macos-latest
+          toolchain: stable
         - os: windows-latest
+          # Windows uses 1.68 until the napi issue fixed in [email protected]
+          # percolates its way up our dependency graph.
+          # https://github.com/MSxDOS/ntapi/issues/15
+          # (will require a new `yaque` version, since that's what transitively pulls this in).
+          toolchain: '1.68'
 
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v3
     - uses: actions-rs/toolchain@v1
       with:
         profile: minimal
-        toolchain: stable
+        toolchain: ${{ matrix.toolchain }}
     - uses: Swatinem/rust-cache@v2
       with:
         shared-key: "dynamic-analysis"
@@ -42,16 +49,23 @@ jobs:
       matrix:
         include:
         - os: ubuntu-latest
+          toolchain: stable
         - os: macos-latest
+          toolchain: stable
         - os: windows-latest
+          # Windows uses 1.68 until the napi issue fixed in [email protected]
+          # percolates its way up our dependency graph.
+          # https://github.com/MSxDOS/ntapi/issues/15
+          # (will require a new `yaque` version, since that's what transitively pulls this in).
+          toolchain: '1.68'
 
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v3
     - uses: actions-rs/toolchain@v1
       with:
         profile: minimal
-        toolchain: stable
+        toolchain: ${{ matrix.toolchain }}
     - uses: Swatinem/rust-cache@v2
       with:
         shared-key: "dynamic-analysis"

CHANGELOG.md

@@ -1,3 +1,15 @@
+
+## v0.2.0
+
+Adds debug bundle generation to `broker fix`.
+Debug bundles are generated automatically if `broker fix` finds errors, or can be generated via `broker fix --export-bundle`.
+
+For more information see the [`fix` subcommand documentation](https://github.com/fossas/broker/blob/main/docs/subcommands/fix.md)
+and the [debug bundle reference](https://github.com/fossas/broker/blob/main/docs/reference/debug-bundle.md).
+
+Adds support for assigning newly imported projects to a team in FOSSA and setting their title.
+For more information, see the [config reference](https://github.com/fossas/broker/blob/main/docs/reference/config.md#integrations).
+
 ## v0.1.1
 
 Add `broker fix`

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "broker"
-version = "0.1.1"
+version = "0.2.0"
 edition = "2021"
 description = "The bridge between FOSSA and internal DevOps services"
 readme = "README.md"
@@ -14,7 +14,7 @@ rust-version = "1.68"
 
 [dependencies]
 bytesize = { version = "1.2.0", features = ["serde"] }
-clap = { version = "4.2.2", features = ["derive", "cargo", "env"] }
+clap = { version = "4.2.4", features = ["derive", "cargo", "env"] }
 colored = "2.0.0"
 delegate = "0.9.0"
 derive-new = "0.5.9"
@@ -28,7 +28,7 @@ indoc = "2.0.1"
 once_cell = "1.17.1"
 rolling-file = "0.2.0"
 secrecy = { version = "0.8.0", features = ["serde"] }
-serde = { version = "1.0.159", features = ["derive"] }
+serde = { version = "1.0.160", features = ["derive"] }
 strum = { version = "0.24.1", features = ["derive"] }
 subtle = "2.4.1"
 tempfile = "3.5.0"
@@ -46,7 +46,7 @@ yaque = "0.6.4"
 reqwest = "0.11.16"
 zip = "0.6.4"
 bytes = "1.4.0"
-sqlx = { version = "0.6.2", features = ["runtime-tokio-rustls", "sqlite", "migrate", "macros", "time", "offline"] }
+sqlx = { version = "0.6.3", features = ["runtime-tokio-rustls", "sqlite", "migrate", "macros", "time", "offline"] }
 async-trait = "0.1.68"
 semver = { version = "1.0.17", features = ["serde"] }
 tap = "1.0.1"
@@ -60,6 +60,10 @@ duplicate = "1.0.0"
 aho-corasick = "0.7.20"
 regex = "1.7.3"
 srclib = { git = "https://github.com/fossas/foundation-libs", branch = "add-srclib" }
+walkdir = "2.3.3"
+tar = "0.4.38"
+libflate = "1.3.0"
+typed-builder = "0.14.0"
 
 [dev-dependencies]
 insta = { version = "1.29.0", features = ["filters", "json", "yaml"] }

Cargo.toml

@@ -50,6 +50,13 @@ cargo dist generate-ci github \
   --installer github-shell
 ```
 
+### cross compilation
+
+Sometimes, especially when debugging a platform build issue, it's useful to "cross compile" the project
+from your home operating system to a destination operating system.
+
+Steps to do so are located in the [cross compilation reference](./reference/cross-compile.md).
+
 ### snapshot testing
 
 Broker uses [insta](https://docs.rs/insta) to perform snapshot testing of outputs.

docs/dev/README.md

@@ -0,0 +1,36 @@
+# Reference: Cross compilation
+
+You're working on Broker with a macOS or Linux system, and everything is going great.
+
+Satisfied with your work, you push a PR, and sit back to get a cup of coff-
+wait, what's that Windows build issue?
+
+```
+error[E0793]: reference to packed field is unaligned
+    --> C:\Users\runneradmin\.cargo\registry\src\index.crates.io-6f17d22bba15001f\ntapi-0.3.7\src\ntexapi.rs:2783:52
+     |
+2783 |         *tick_count.QuadPart_mut() = read_volatile(&(*USER_SHARED_DATA).u.TickCountQuad);
+     |                                                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+     |
+     = note: fields of packed structs are not properly aligned, and creating a misaligned reference is undefined behavior (even if that reference is never dereferenced)
+     = help: copy the field contents to a local variable, or replace the reference with a raw pointer and use `read_unaligned`/`write_unaligned` (loads and stores via `*p` must be properly aligned even when using raw pointers)
+```
+
+You then spend several PR cycles trying to get this to be fixed, each time with a delay (and a bunch of wasteful parallel
+CI jobs running, whose results you don't care about).
+
+Wouldn't it be better if instead, you could just build for Windows locally?
+
+## The better way
+
+You can! ✨
+
+Steps:
+
+1. Install the `mingw-64` package.
+  - On macOS, that's `brew install mingw-w64`
+  - On Debian/Ubuntu, that's `sudo apt-get install mingw-w64`
+1. `rustup target add x86_64-pc-windows-gnu`
+1. `cargo build --target x86_64-pc-windows-gnu`
+
+Now your build still fails but at least your testing loop is faster 🥲