Merge pull request #21 from opencomputeproject/fea/spec_validation

fea/spec validation

.github/workflows/test.yaml

@@ -68,3 +68,29 @@ jobs:
           fail_ci_if_error: true
           token: ${{ secrets.CODECOV_TOKEN }}
           env_vars: OS,RUSTVER
+
+  spec:
+    runs-on: ubuntu-latest
+    name: examples / spec validation
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install rust stable
+        uses: dtolnay/rust-toolchain@stable
+      - name: pull validator
+        run: git clone https://github.com/opencomputeproject/ocp-diag-core.git --depth=1
+      - name: Install go
+        uses: actions/setup-go@v2
+        with:
+          go-version: "1.17.6"
+      - name: run validator against examples
+        run: |
+          ROOT="$(pwd)"
+          cd ocp-diag-core/validators/spec_validator
+          cargo metadata --manifest-path $ROOT/Cargo.toml --format-version 1 |
+            jq -r '.["packages"][] | select(.name == "ocptv") | .targets[] | select(.kind[0] == "example") | .name' |
+            xargs -I{} bash -c "
+              echo validating output of example {}... &&
+              cargo run --manifest-path $ROOT/Cargo.toml --example {} |
+              tee /dev/stderr |
+              go run . -schema ../../json_spec/output/root.json -
+            "

examples/extensions.rs

@@ -16,7 +16,7 @@ enum ExtensionType {
 }
 
 #[derive(Serialize)]
-struct ComplexExtension {
+struct Extension {
     #[serde(rename = "@type")]
     ext_type: ExtensionType,
 
@@ -25,13 +25,11 @@ struct ComplexExtension {
 }
 
 async fn step0(s: tv::ScopedTestStep) -> Result<TestStatus, tv::OcptvError> {
-    s.add_extension("simple", "extension_identifier").await?;
-
     s.add_extension(
-        "complex",
-        ComplexExtension {
+        "ext0",
+        Extension {
             ext_type: ExtensionType::Example,
-            field: "demo".to_owned(),
+            field: "example".to_owned(),
             subtypes: vec![1, 42],
         },
     )

examples/measurement_concurrency.rs

@@ -0,0 +1,62 @@
+// (c) Meta Platforms, Inc. and affiliates.
+//
+// Use of this source code is governed by an MIT-style
+// license that can be found in the LICENSE file or at
+// https://opensource.org/licenses/MIT.
+
+use std::{sync::Arc, time::Duration};
+
+use anyhow::Result;
+use rand;
+
+use ocptv::output as tv;
+use tv::{DutInfo, TestResult, TestRun, TestRunOutcome, TestStatus};
+
+/// While the general recommendation is to run test steps sequentially, the specification does not
+/// mandate for this to happen. This example shows multiple steps running in parallel, each
+/// emitting their own measurements.
+#[tokio::main(flavor = "multi_thread", worker_threads = 10)]
+async fn main() -> Result<()> {
+    let dut = DutInfo::builder("dut0").build();
+
+    TestRun::builder("simple measurement", "1.0")
+        .build()
+        .scope(dut, |r| async move {
+            let run = Arc::new(r);
+
+            let tasks = (0..5)
+                .map(|i| {
+                    tokio::spawn({
+                        let r = Arc::clone(&run);
+                        async move {
+                            r.add_step(&format!("step{}", i))
+                                .scope(move |s| async move {
+                                    let offset = rand::random::<u64>() % 10000;
+                                    tokio::time::sleep(Duration::from_micros(offset)).await;
+
+                                    let fan_speed = 1000 + 100 * i;
+                                    s.add_measurement(&format!("fan{}", i), fan_speed)
+                                        .await
+                                        .unwrap();
+
+                                    Ok(TestStatus::Complete)
+                                })
+                                .await
+                        }
+                    })
+                })
+                .collect::<Vec<_>>();
+
+            for t in tasks {
+                t.await.map_err(|e| tv::OcptvError::Other(Box::new(e)))??;
+            }
+
+            Ok(TestRunOutcome {
+                status: TestStatus::Complete,
+                result: TestResult::Pass,
+            })
+        })
+        .await?;
+
+    Ok(())
+}

examples/measurement_series.rs

@@ -3,7 +3,6 @@
 // Use of this source code is governed by an MIT-style
 // license that can be found in the LICENSE file or at
 // https://opensource.org/licenses/MIT.
-#![allow(warnings)]
 
 use anyhow::Result;
 use chrono::Duration;

examples/measurement_subcomponent.rs

@@ -3,7 +3,6 @@
 // Use of this source code is governed by an MIT-style
 // license that can be found in the LICENSE file or at
 // https://opensource.org/licenses/MIT.
-// #![allow(warnings)]
 
 use anyhow::Result;
 

examples/measurement_validators.rs

@@ -3,7 +3,6 @@
 // Use of this source code is governed by an MIT-style
 // license that can be found in the LICENSE file or at
 // https://opensource.org/licenses/MIT.
-// #![allow(warnings)]
 
 use anyhow::Result;
 

src/output/mod.rs

@@ -55,4 +55,7 @@ pub enum OcptvError {
 
     #[error("failed to format input object")]
     Format(Box<dyn std::error::Error + Send + Sync + 'static>), // opaque type so we don't leak impl
+
+    #[error("other error")]
+    Other(Box<dyn std::error::Error + Send + Sync + 'static>),
 }

src/spec.rs

@@ -875,7 +875,7 @@ pub struct Diagnosis {
 #[derive(Debug, Serialize, PartialEq, Clone)]
 #[serde(rename = "file")]
 pub struct File {
-    #[serde(rename = "name")]
+    #[serde(rename = "displayName")]
     pub name: String,
 
     #[serde(rename = "uri")]

tests/output/file.rs

@@ -22,7 +22,7 @@ async fn test_step_with_file() -> Result<()> {
             "testStepArtifact": {
                 "testStepId": "step0",
                 "file": {
-                    "name": "name",
+                    "displayName": "name",
                     "uri": uri.clone().as_str().to_owned(),
                     "isSnapshot": false
                 }
@@ -53,7 +53,7 @@ async fn test_step_with_file_builder() -> Result<()> {
             "testStepArtifact": {
                 "testStepId": "step0",
                 "file": {
-                    "name": "name",
+                    "displayName": "name",
                     "uri": uri.clone().as_str().to_owned(),
                     "isSnapshot": false,
                     "contentType": "text/plain",