Merge pull request #1103 from SteveL-MSFT/context-function

Add `context()` function and refactor osinfo

Author: SteveL-MSFT

build.ps1

@@ -339,6 +339,7 @@ if (!$SkipBuild) {
         "tree-sitter-dscexpression",
         "tree-sitter-ssh-server-config",
         "security_context_lib",
+        "lib/osinfo_lib",
         "dsc_lib",
         "dsc",
         "dscecho",

dsc/Cargo.lock

@@ -14,8 +14,8 @@ Describe 'dsc config test tests' {
          - name: Is64BitOS
            type: Microsoft/OSInfo
            properties:
-             bitness: '64'
-         - name: 64bit test 2
+             bitness: 64
+         - name: Family Test
            type: Microsoft/OSInfo
            properties:
              family: Windows

dsc/tests/dsc_config_test.tests.ps1

@@ -483,4 +483,24 @@ Describe 'tests for function expressions' {
     $LASTEXITCODE | Should -Be 0 -Because (Get-Content $TestDrive/error.log -Raw)
     ($out.results[0].result.actualState.output | Out-String) | Should -BeExactly ($expected | Out-String)
   }
+
+  It 'context function works' {
+    $config_yaml = @"
+            `$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+            resources:
+            - name: Echo
+              type: Microsoft.DSC.Debug/Echo
+              properties:
+                output: "[context()]"
+"@
+    $out = dsc -l trace config get -i $config_yaml 2>$TestDrive/error.log | ConvertFrom-Json
+    $LASTEXITCODE | Should -Be 0 -Because (Get-Content $TestDrive/error.log -Raw)
+    $context = $out.results[0].result.actualState.output
+    $os = osinfo | ConvertFrom-Json
+    $context.os.family | Should -BeExactly $os.family
+    $context.os.version | Should -BeExactly $os.version
+    $context.os.bitness | Should -BeExactly $os.bitness
+    $context.os.architecture | Should -BeExactly $os.architecture
+    $context.security | Should -BeExactly $out.metadata.'Microsoft.DSC'.securityContext
+  }
 }

dsc/tests/dsc_functions.tests.ps1

@@ -23,6 +23,7 @@ jsonschema = { version = "0.33", default-features = false }
 linked-hash-map = "0.5"
 murmurhash64 = "0.3"
 num-traits = "0.2"
+osinfo_lib = { path = "../lib/osinfo_lib" }
 path-absolutize = { version = "3.1" }
 regex = "1.11"
 rt-format = "0.3"

dsc_lib/Cargo.lock

@@ -266,6 +266,10 @@ invoked = "contains function"
 invalidItemToFind = "Invalid item to find, must be a string or number"
 invalidArgType = "Invalid argument type, first argument must be an array, object, or string"
 
+[functions.context]
+description = "Retrieves context information about the current execution environment"
+invoked = "context function"
+
 [functions.copyIndex]
 description = "Returns the current copy index"
 invoked = "copyIndex function"

dsc_lib/Cargo.toml

@@ -0,0 +1,43 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+use crate::DscError;
+use crate::configure::{context::Context as ConfigContext, config_doc::SecurityContextKind};
+use crate::functions::{FunctionArgKind, Function, FunctionCategory, FunctionMetadata};
+use osinfo_lib::OsInfo;
+use rust_i18n::t;
+use serde::Serialize;
+use serde_json::Value;
+use tracing::debug;
+
+#[derive(Debug, Serialize)]
+pub struct ContextInfo {
+    os: OsInfo,
+    security: SecurityContextKind,
+}
+
+pub struct Context {}
+
+impl Function for Context {
+    fn get_metadata(&self) -> FunctionMetadata {
+        FunctionMetadata {
+            name: "context".to_string(),
+            description: t!("functions.context.description").to_string(),
+            category: FunctionCategory::System,
+            min_args: 0,
+            max_args: 0,
+            accepted_arg_ordered_types: vec![],
+            remaining_arg_accepted_types: None,
+            return_types: vec![FunctionArgKind::Object],
+        }
+    }
+
+    fn invoke(&self, _args: &[Value], config_context: &ConfigContext) -> Result<Value, DscError> {
+        debug!("{}", t!("functions.context.invoked"));
+        let context = ContextInfo {
+            os: OsInfo::new(false),
+            security: config_context.security_context.clone(),
+        };
+        Ok(serde_json::to_value(context)?)
+    }
+}

dsc_lib/locales/en-us.toml

@@ -20,6 +20,7 @@ pub mod bool;
 pub mod coalesce;
 pub mod concat;
 pub mod contains;
+pub mod context;
 pub mod copy_index;
 pub mod create_array;
 pub mod create_object;
@@ -134,6 +135,7 @@ impl FunctionDispatcher {
             Box::new(coalesce::Coalesce{}),
             Box::new(concat::Concat{}),
             Box::new(contains::Contains{}),
+            Box::new(context::Context{}),
             Box::new(copy_index::CopyIndex{}),
             Box::new(create_array::CreateArray{}),
             Box::new(create_object::CreateObject{}),