@grnsft/if 0.3.2 → 0.3.3-beta.0

package/manifests/bugs/initialize-error-no-path.yml

@@ -0,0 +1,28 @@
+name: initialize-error-no-path
+description: a negative test case that fails because the path is mising in a plugin initialization
+tags:
+initialize:
+  plugins:
+    teads-curve: 
+      path:
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+  outputs: ['yaml']
+tree:
+  children:
+    child-0:
+      defaults:
+        cpu/thermal-design-power: 100
+      pipeline:
+        - teads-curve
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 1
+          cpu/utilization: 20
+        - timestamp: 2023-07-06T00:01
+          duration: 1
+          cpu/utilization: 80
+        - timestamp: 2023-07-06T00:02
+          duration: 1
+          cpu/utilization: 20

package/manifests/bugs/initialize-error-no-plugins.yml

@@ -0,0 +1,23 @@
+name: initialize-error-no-path
+description: a negative test case that fails becuase no plugins are included in the initialize block
+tags:
+initialize:
+  plugins:
+  outputs: ['yaml']
+tree:
+  children:
+    child-0:
+      defaults:
+        cpu/thermal-design-power: 100
+      pipeline:
+        - teads-curve
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 1
+          cpu/utilization: 20
+        - timestamp: 2023-07-06T00:01
+          duration: 1
+          cpu/utilization: 80
+        - timestamp: 2023-07-06T00:02
+          duration: 1
+          cpu/utilization: 20

package/manifests/bugs/input-error-missing-duration.yml

@@ -0,0 +1,21 @@
+name: input-error-missing-duration
+description: a negative test case that fails due to the required `duration` field being omitted from input data
+tags:
+initialize:
+  plugins:
+    teads-curve: 
+      path: '@grnsft/if-unofficial-plugins'
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+  outputs: ['yaml']
+tree:
+  children:
+    child-0:
+      defaults:
+        cpu/thermal-design-power: 100
+      pipeline:
+        - teads-curve
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          cpu/utilization: 20

package/manifests/bugs/pipeline-error-naming-mismatch.yml

@@ -0,0 +1,28 @@
+name: pipeline-error-naming-mismatch
+description: a negative test case that fails due to the plugin name in the pipeline not matching the name given in initialize 
+tags:
+initialize:
+  plugins:
+    teads-curve: 
+      path: '@grnsft/if-unofficial-plugins'
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+  outputs: ['yaml']
+tree:
+  children:
+    child-0:
+      defaults:
+        cpu/thermal-design-power: 100
+      pipeline:
+        - wrong-name
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 1
+          cpu/utilization: 20
+        - timestamp: 2023-07-06T00:01
+          duration: 1
+          cpu/utilization: 80
+        - timestamp: 2023-07-06T00:02
+          duration: 1
+          cpu/utilization: 20

package/manifests/bugs/pipeline-error-uninitialized-plugin.yml

@@ -0,0 +1,29 @@
+name: pipeline-uninitialized-plugin-error
+description: a negative test case that fails due to an uninitialized plugin being invoked in a pipeline
+tags:
+initialize:
+  plugins:
+    teads-curve: 
+      path: '@grnsft/if-unofficial-plugins'
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+  outputs: ['yaml']
+tree:
+  children:
+    child-0:
+      defaults:
+        cpu/thermal-design-power: 100
+      pipeline:
+        - teads-curve
+        - multiply
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 1
+          cpu/utilization: 20
+        - timestamp: 2023-07-06T00:01
+          duration: 1
+          cpu/utilization: 80
+        - timestamp: 2023-07-06T00:02
+          duration: 1
+          cpu/utilization: 20

package/{examples/manifests/boavizta-pipeline.yml → manifests/bugs/pipeline-ordering-error.yml}

@@ -1,14 +1,13 @@
-name: boavizta-demo
-description:
+name: pipeline-ordering-error
+description: a negative test case that fails because sci-o is invoked too early in the pipeline (before its inputs are generated)
 tags:
 initialize:
   plugins:
-    boavizta-cpu:
-      method: BoaviztaCpuOutput
+    "teads-curve":
       path: "@grnsft/if-unofficial-plugins"
+      method: TeadsCurve
       global-config:
-        allocation: LINEAR
-        verbose: true
+        interpolation: spline
     "sum":
       path: "@grnsft/if-plugins"
       method: Sum
@@ -41,10 +40,10 @@ tree:
   children:
     child-1:
       pipeline:
-        - boavizta-cpu
+        - teads-curve
+        - sci-o
         - sum
         - sci-m
-        - sci-o
         - time-sync
         - sci
       config:
@@ -56,8 +55,6 @@ tree:
         device/expected-lifespan: 94608000 # 3 years in seconds
         resources-reserved: 1
         resources-total: 8
-        cpu/number-cores: 24
-        cpu/name: Intel® Core™ i7-1185G7
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
           cloud/instance-type: A1

package/{examples/manifests → manifests/examples}/basic.yml

@@ -1,5 +1,5 @@
-name: basic-demo
-description:
+name: basic
+description: a minimal manifest executing a single plugin on a single component for a single timestep
 tags:
 initialize:
   plugins:
@@ -8,6 +8,7 @@ initialize:
       method: TeadsCurve
       global-config:
         interpolation: spline
+  outputs: ['yaml']
 tree:
   children:
     child-0:

package/{examples/manifests → manifests/examples}/generics.yml

@@ -1,5 +1,5 @@
-name: generic-arithmetic-demo
-description:
+name: generics
+description: a pipeline that does arbitrary calculations using our generic arithmetic builtins
 tags:
 initialize:
   plugins:

package/{examples/manifests/asim-demo.yml → manifests/examples/mock-cpu-util-to-carbon.yml}

@@ -1,11 +1,7 @@
-name: My Manifest File
-description: My First Manifest File 💚
-# aggregation:
-#   metrics:
-#     - 'carbon'
-#   type: 'both'
+name: mock-cpu-util-to-carbon
+description: a complete pipeline that starts with mocked CPU utilization data and outputs operational carbon in gCO2eq
 initialize:
-  outputs: ['yaml', 'csv']
+  outputs: ['yaml']
   plugins: 
     group-by: 
       path: 'builtin'

package/{examples/manifests → manifests/examples}/nesting.yml

@@ -1,5 +1,5 @@
-name: nesting-demo
-description: null
+name: nesting
+description: a manifest that includes nested child components
 tags:
   kind: web
   complexity: moderate
@@ -11,6 +11,7 @@ aggregation:
   type: "both"
 params:
 initialize:
+  outputs: ['yaml']
   plugins:
     teads-curve:
       path: "@grnsft/if-unofficial-plugins"

package/{examples/manifests → manifests/examples}/pipeline-teads-sci.yml

@@ -1,5 +1,5 @@
 name: pipeline-teads-sci
-description:
+description: a full pipeline seeded with some hardcoded input data and yielding an SCI score
 tags:
 initialize:
   plugins:

package/{examples/manifests/pipeline-demo.yml → manifests/examples/pipeline-with-aggregate.yml}

@@ -1,5 +1,5 @@
-name: realistic-pipeline-demo
-description:
+name: pipeline-with-aggregate
+description: a full pipeline with the aggregate feature enabled
 tags:
 aggregation:
   metrics:

package/{examples/manifests → manifests/examples}/pipeline-with-mocks.yml

@@ -1,5 +1,5 @@
-name: pipeline-with-mock-obs-demo
-description:
+name: pipeline-with-mocks
+description: a full pipeline seeded with data from mock-observations feature
 tags:
 aggregation:
   metrics:
@@ -56,6 +56,7 @@ initialize:
     "group-by":
       path: builtin
       method: GroupBy
+  outputs: ['yaml']
 tree:
   children:
     child-1:

package/manifests/features/aggregate-horizontal.yml

@@ -0,0 +1,44 @@
+name: Aggregation
+description: Apply `horizontal` aggregation
+aggregation:
+  metrics:
+    - 'cpu/utilization'
+  type: 'horizontal'
+initialize:
+  plugins:
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"              
+tree:
+  children:
+    application:
+      pipeline:
+        - cloud-metadata
+      children:
+        uk-west:
+          children:
+            server-1:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 89
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 59
+            server-2:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 24
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 27
+                

package/manifests/features/aggregate-vertical.yml

@@ -0,0 +1,44 @@
+name: Aggregation
+description: Apply `vertical` aggregation
+aggregation:
+  metrics:
+    - 'cpu/utilization'
+  type: 'vertical'
+initialize:
+  plugins:
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"              
+tree:
+  children:
+    application:
+      pipeline:
+        - cloud-metadata
+      children:
+        uk-west:
+          children:
+            server-1:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 89
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 59
+            server-2:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 24
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 27
+                

package/manifests/features/aggregate.yml

@@ -0,0 +1,44 @@
+name: Aggregation
+description: Apply both `horizontal` and `vertical` aggregations
+aggregation:
+  metrics:
+    - 'cpu/utilization'
+  type: 'both'
+initialize:
+  plugins:
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"              
+tree:
+  children:
+    application:
+      pipeline:
+        - cloud-metadata
+      children:
+        uk-west:
+          children:
+            server-1:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 89
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 59
+            server-2:
+              inputs:
+                - timestamp: '2024-02-26 00:00:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 24
+                - timestamp: '2024-02-26 00:05:00'
+                  duration: 300
+                  cloud/instance-type: m5n.large
+                  cloud/vendor: aws
+                  cpu/utilization: 27
+                

package/manifests/integrations/mock-obs-groupby.yml

@@ -0,0 +1,39 @@
+name: Mock observations + Group by
+description: Integration of `mock observations` + `groupby plugins`
+initialize: 
+  plugins: 
+    mock-observations:
+      path: '@grnsft/if-plugins'
+      method: MockObservations
+      global-config:
+        timestamp-from: '2024-03-05T00:00:00.000Z'
+        timestamp-to: '2024-03-05T00:01:00.000Z'
+        duration: 10
+        components:
+          - name: server-1
+            cloud/instance-type: Standard_E64_v3
+            cloud/region: westus3
+          - name: server-2
+            cloud/instance-type: Standard_E64_v3
+            cloud/region: france            
+        generators:
+          common:
+            cloud/vendor: azure
+          randint:
+            cpu/utilization:
+              min: 1
+              max: 99
+    group-by: 
+      path: 'builtin'
+      method: GroupBy          
+tree: 
+  pipeline:
+    - mock-observations
+    - group-by
+  defaults:
+  config:
+    group-by:
+      group:
+        - cloud/region
+        - name
+  inputs: null

package/manifests/integrations/mock-obs-time-sync.yml

@@ -0,0 +1,65 @@
+name: Mock observation and time sync integration
+description: Integration of `mock observation` + `time sync`
+tags:
+initialize:
+  plugins:
+    mock-observations:
+      kind: plugin
+      method: MockObservations
+      path: "@grnsft/if-plugins"
+      global-config:
+        timestamp-from: 2023-07-06T00:00
+        timestamp-to: 2023-07-06T00:10
+        duration: 60
+        components:
+          - cloud/instance-type: A1
+        generators:
+          common:
+            cloud/region: uk-west
+            common-key: common-val
+          randint:
+            cpu/utilization:
+              min: 1
+              max: 99
+    "teads-curve":
+      path: "@grnsft/if-unofficial-plugins"
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+    "time-sync":
+      method: TimeSync
+      path: "builtin"
+      global-config:
+        start-time: "2023-12-12T00:00:00.000Z"
+        end-time: "2023-12-12T00:01:00.000Z"
+        interval: 5
+        allow-padding: true
+tree:
+  children:
+    child-1:
+      pipeline:
+        - teads-curve
+        - time-sync        
+      defaults:
+        cpu/thermal-design-power: 100
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          duration: 1
+          cpu/utilization: 10
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 20
+          cloud/instance-type: A1
+          cloud/region: uk-west
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 15
+          cloud/instance-type: A1
+          cloud/region: uk-west
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 15

package/manifests/plugins/cloud-metadata/failure-invalid-vendor.yaml

@@ -0,0 +1,21 @@
+name: cloud-metadata
+description: failure with invalid `inputs.cloud/vendor`
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+      config:
+      inputs:
+        - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
+          cloud/vendor: gcp
+          cloud/instance-type: m5n.large
+          duration: 100
+          cpu/utilization: 10

package/{examples/manifests/cloud-metadata.yml → manifests/plugins/cloud-metadata/success.yml}

@@ -1,7 +1,8 @@
 name: cloud-metadata
-description: example impl invoking Cloud Metadata plugin
+description: successful path
 tags:
 initialize:
+  outputs: ['yaml']
   plugins:
     cloud-metadata:
       method: CloudMetadata

package/manifests/plugins/coefficient/failure-invalid-config-input-param.yml

@@ -0,0 +1,24 @@
+name: coefficient-demo
+description: failure with ivalid `global-config.input-parameter`
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    coefficient:
+      method: Coefficient
+      path: "@grnsft/if-plugins"
+      global-config:
+        input-parameter: 4
+        coefficient: 3
+        output-parameter: "carbon-product"
+tree:
+  children:
+    child:
+      pipeline:
+        - coefficient
+      config:
+        sum:
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          carbon: 30

package/{examples/manifests/coefficient.yml → manifests/plugins/coefficient/success.yml}

@@ -1,7 +1,8 @@
 name: coefficient-demo
-description:
+description: successful path
 tags:
 initialize:
+  outputs: ['yaml']
   plugins:
     coefficient:
       method: Coefficient

package/manifests/plugins/divide/failure-invalid-config-denominator.yml

@@ -0,0 +1,39 @@
+name: divide
+description: failure when `global-config.denominator` is string
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"
+    divide:
+      method: Divide
+      path: "@grnsft/if-plugins"
+      global-config:
+        numerator: vcpus-allocated
+        denominator: 'vcpus'
+        output: cpu/number-cores
+    boavizta-cpu:
+      method: BoaviztaCpuOutput
+      path: "@grnsft/if-unofficial-plugins"
+      global-config:
+        allocation: LINEAR
+        verbose: true
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+        - divide
+        - boavizta-cpu
+      config:
+        divide:
+      defaults:
+        cloud/vendor: aws
+        cloud/instance-type: m5n.large
+        cpu/name: Intel® Core™ i7-1185G7
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu/utilization: 80

package/manifests/plugins/divide/success.yml

@@ -0,0 +1,39 @@
+name: divide
+description: success path
+tags:
+initialize:
+  outputs: ['yaml']
+  plugins:
+    cloud-metadata:
+      method: CloudMetadata
+      path: "@grnsft/if-plugins"
+    divide:
+      method: Divide
+      path: "@grnsft/if-plugins"
+      global-config:
+        numerator: vcpus-allocated
+        denominator: 2
+        output: cpu/number-cores
+    boavizta-cpu:
+      method: BoaviztaCpuOutput
+      path: "@grnsft/if-unofficial-plugins"
+      global-config:
+        allocation: LINEAR
+        verbose: true
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-metadata
+        - divide
+        - boavizta-cpu
+      config:
+        divide:
+      defaults:
+        cloud/vendor: aws
+        cloud/instance-type: m5n.large
+        cpu/name: Intel® Core™ i7-1185G7
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu/utilization: 80