Add GitHub Destination as place to report (#2)

Allow users to specify GitHub Issue as a place to upload reports.

Author: ethankhall

Cargo.lock

@@ -91,7 +91,15 @@ Used to diagnose errors with an engineers environment. Used when running `pity d
 
 [source,yaml]
 ....
-include::{exampleDir}/doctor-check.yaml[]
+apiVersion: pity.github.com/v1alpha
+kind: PityDoctorCheck
+metadata:
+  name: path-exists
+spec:
+  exec:
+    target: scripts/does-path-env-exist.sh
+  description: Check your shell for basic functionality
+  help: You're shell does not have a path env. Reload your shell.
 ....
 
 From the example, when the check runs it will execute `scripts/does-path-env-exist.sh` which is defined relative to the file containing the check.
@@ -108,7 +116,14 @@ A common example is a dependency is missing, the node modules might need to be c
 
 [source,yaml]
 ....
-include::{exampleDir}/known-error.yaml[]
+apiVersion: pity.github.com/v1alpha
+kind: PityKnownError
+metadata:
+  name: error-exists
+spec:
+  description: Check if the word error is in the logs
+  pattern: error
+  help: The command had an error, try reading the logs around there to find out what happened.
 ....
 
 [cols="1,2"]
@@ -135,7 +150,20 @@ When using `pity-intercept` or `pity report`, a user is able to upload the error
 
 [source,yaml]
 ....
-include::{exampleDir}/report.yaml[]
+apiVersion: pity.github.com/v1alpha
+kind: PityReport
+metadata:
+  name: report
+spec:
+  additionalData:
+    username: id -u
+    ruby: which ruby
+    node: which node
+    nodeVersion: node -v
+  destination:
+    githubIssue:
+      owner: ethankhall
+      repo: dummy-repo
 ....
 
 [cols="1,2"]
@@ -147,9 +175,18 @@ a| `.spec.additionalData`
 | A map of `name` to `command`. Pity will run the command and capture the output as part of the report.
 
 a| `.spec.destination`
-a| Currently, supports https://github.com/orhun/rustypaste[`rustyPaste`] as a source.
+a| Currently, supports GitHubIssues and https://github.com/orhun/rustypaste[`rustyPaste`] as a source.
 Additional options will be added in the future.
 
+a| `.spec.destination.githubIssue.owner`
+a| (required) GitHub owner part of the slug. (ie. `ethankhall`)
+
+a| `.spec.destination.githubIssue.owner`
+a| (required) GitHub repo name (ie. `pity`)
+
+a| `.spec.destination.githubIssue.tags`
+a| List of tags to add to the issue.
+
 a| `.spec.destination.rustyPaste.url`
-| URL to upload the report to.
+a| URL to upload the report to.
 |===

README.adoc

@@ -1,3 +1,4 @@
+---
 apiVersion: pity.github.com/v1alpha
 kind: PityReport
 metadata:
@@ -11,4 +12,14 @@ spec:
     nodeVersion: node -v
   destination:
     rustyPaste:
-      url: http://localhost:8000
+      url: http://localhost:8000
+---
+apiVersion: pity.github.com/v1alpha
+kind: PityReport
+metadata:
+  name: github
+spec:
+  destination:
+    githubIssue:
+      owner: ethankhall
+      repo: dummy-repo

examples/report.yaml

@@ -1,5 +1,6 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 
+# This script will always fail.
 if [[ "z$PATH" == "z" ]]; then
     exit 1
 fi

examples/scripts/does-path-env-exist.sh

@@ -1,5 +1,6 @@
 #!/usr/bin/env -S cargo run --bin pity-intercept -- --extra-config examples bash
 
+>&2 echo "error 1!"
+sleep 1
 echo "hello world"
-echo "error 1!"
 exit 1

examples/test.sh

@@ -94,12 +94,13 @@ async fn run_command(opts: Cli) -> anyhow::Result<i32> {
         )
         .prompt();
 
+    let report_builder = ReportBuilder::new(capture, &found_config.report_upload);
     if let Ok(true) = ans {
-        let report_builder = ReportBuilder::new(capture, &found_config.report_upload);
-
         if let Err(e) = report_builder.distribute_report().await {
             warn!(target: "user", "Unable to upload report: {}", e);
         }
+    } else {
+        report_builder.write_local_report().ok();
     }
     Ok(exit_code)
 }

pity-intercept/src/main.rs

@@ -23,4 +23,5 @@ log = "0.4.16"
 regex = "1"
 derivative = "2"
 reqwest = { version = "0.11.23", features = ["multipart"] }
-time = { version = "0.3.31", features = ["macros", "formatting", "local-offset"] }
+time = { version = "0.3.31", features = ["macros", "formatting", "local-offset"] }
+json = "0.12"

pity-lib/Cargo.toml

@@ -135,7 +135,7 @@ impl OutputCapture {
 
     pub fn create_report_text(&self, title: Option<&str>) -> anyhow::Result<String> {
         let mut f = String::new();
-        let title = title.unwrap_or("== Command Results");
+        let title = title.unwrap_or("## Command Results");
         writeln!(&mut f, "{}\n", title)?;
         writeln!(&mut f, "Ran command `/usr/bin/env -S {}`", self.command)?;
         writeln!(
@@ -148,11 +148,12 @@ impl OutputCapture {
             "Result of command: {}",
             self.exit_code.unwrap_or(-1)
         )?;
-        write!(&mut f, "\n=== Output\n")?;
-        write!(&mut f, "\n[source,text]\n")?;
-        writeln!(&mut f, "....")?;
-        writeln!(&mut f, "{}", self.generate_output())?;
-        writeln!(&mut f, "....")?;
+        writeln!(&mut f)?;
+        writeln!(&mut f, "### Output")?;
+        writeln!(&mut f)?;
+        writeln!(&mut f, "```text")?;
+        writeln!(&mut f, "{}", self.generate_output().trim())?;
+        writeln!(&mut f, "```")?;
         writeln!(&mut f)?;
         Ok(f)
     }