@grnsft/if 0.5.0-beta.0 → 0.6.0-beta.0

package/manifests/examples/pipelines/scenario-3.yml

@@ -0,0 +1,86 @@
+name: groupby
+description: successful path
+initialize:
+  plugins:
+    "sum":
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - cpu/energy
+          - network/energy
+        output-parameter: energy
+tree:
+  children:
+    my-app:
+      pipeline:
+        observe:
+        regroup:
+          - cloud/instance-type
+          - cloud/region
+        compute:
+      children:
+        uk-west:
+          inputs:
+            - timestamp: 2023-07-06T00:00
+              duration: 300
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              cpu/utilization: 99
+            - timestamp: 2023-07-06T05:00
+              duration: 300
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              cpu/utilization: 23
+            - timestamp: 2023-07-06T10:00
+              duration: 300
+              cloud/instance-type: A1
+              cloud/region: uk-west
+              cpu/utilization: 12
+            - timestamp: 2023-07-06T00:00
+              duration: 300
+              cloud/instance-type: B1
+              cloud/region: uk-west
+              cpu/utilization: 11
+            - timestamp: 2023-07-06T05:00
+              duration: 300
+              cloud/instance-type: B1
+              cloud/region: uk-west
+              cpu/utilization: 67
+            - timestamp: 2023-07-06T10:00
+              duration: 300
+              cloud/instance-type: B1
+              cloud/region: uk-west
+              cpu/utilization: 1
+        uk-east:
+          inputs:
+            - timestamp: 2023-07-06T00:00
+              duration: 300
+              cloud/instance-type: A1
+              cloud/region: uk-east
+              cpu/utilization: 9
+            - timestamp: 2023-07-06T05:00
+              duration: 300
+              cloud/instance-type: A1
+              cloud/region: uk-east
+              cpu/utilization: 23
+            - timestamp: 2023-07-06T10:00
+              duration: 300
+              cloud/instance-type: A1
+              cloud/region: uk-east
+              cpu/utilization: 12
+            - timestamp: 2023-07-06T00:00
+              duration: 300
+              cloud/instance-type: B1
+              cloud/region: uk-east
+              cpu/utilization: 11
+            - timestamp: 2023-07-06T05:00
+              duration: 300
+              cloud/instance-type: B1
+              cloud/region: uk-east
+              cpu/utilization: 67
+            - timestamp: 2023-07-06T10:00
+              duration: 300
+              cloud/instance-type: B1
+              cloud/region: uk-east
+              cpu/utilization: 1

package/manifests/examples/pipelines/scenario-4.yml

@@ -0,0 +1,46 @@
+name: demo
+description: 
+tags:
+initialize:
+  plugins:
+    "sum":
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - cpu/energy
+          - network/energy
+        output-parameter: energy-sum
+    "coefficient":
+      path: "builtin"
+      method: Coefficient
+      global-config:
+        input-parameter: energy
+        coefficient: 2
+        output-parameter: energy-doubled
+    "multiply":
+      path: "builtin"
+      method: Multiply
+      global-config:
+        input-parameters: ["cpu/utilization", "duration"]
+        output-parameter: "cpu-times-duration"
+tree:
+  children:
+    child-1:
+      pipeline:
+        observe:
+        compute: 
+          - sum
+          - coefficient
+          - multiply
+      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: 50
+          cpu/energy: 20
+          network/energy: 10
+          energy: 5

package/manifests/examples/pipelines/scenario-5.yml

@@ -0,0 +1,46 @@
+name: demo
+description: 
+tags:
+initialize:
+  plugins:
+    mock-observations:
+      kind: plugin
+      method: MockObservations
+      path: "builtin"
+      global-config:
+        timestamp-from: 2023-07-06T00:00
+        timestamp-to: 2023-07-06T00:01
+        duration: 60
+        components:
+          - cloud/instance-type: A1
+          - cloud/instance-type: B1
+        generators:
+          common:
+            region: uk-west
+            common-key: common-val
+          randint:
+            cpu/utilization:
+              min: 1
+              max: 99
+            memory/utilization:
+              min: 1
+              max: 99
+    sum:
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - cpu/utilization
+          - memory/utilization
+        output-parameter: util-sum
+tree:
+  children:
+    child:
+      pipeline:
+        observe:
+          - mock-observations
+        regroup:
+          - cloud/instance-type
+        compute:
+          - sum
+      inputs: null

package/manifests/examples/{sci.yml → pipelines/sci.yml}

@@ -5,13 +5,13 @@ initialize:
   plugins:
     interpolate:
       method: Interpolation
-      path: 'builtin'
+      path: "builtin"
       global-config:
         method: linear
         x: [0, 10, 50, 100]
         y: [0.12, 0.32, 0.75, 1.02]
-        input-parameter: 'cpu/utilization'
-        output-parameter: 'cpu-factor'
+        input-parameter: "cpu/utilization"
+        output-parameter: "cpu-factor"
     cpu-factor-to-wattage:
       method: Multiply
       path: builtin
@@ -75,24 +75,22 @@ initialize:
       method: Sci
       global-config:
         functional-unit: "component"
-  outputs:
-    - yaml
 tree:
   children:
     child-1:
       pipeline:
-        - interpolate
-        - cpu-factor-to-wattage
-        - wattage-times-duration
-        - wattage-to-energy-kwh
-        - calculate-vcpu-ratio
-        - correct-cpu-energy-for-vcpu-ratio
-        - sum-energy-components
-        - embodied-carbon
-        - operational-carbon
-        - sum-carbon
-        - sci
-      config:
+        compute:
+          - interpolate
+          - cpu-factor-to-wattage
+          - wattage-times-duration
+          - wattage-to-energy-kwh
+          - calculate-vcpu-ratio
+          - correct-cpu-energy-for-vcpu-ratio
+          - sum-energy-components
+          - embodied-carbon
+          - operational-carbon
+          - sum-carbon
+          - sci
       defaults:
         cpu/thermal-design-power: 100
         vcpus-total: 8

package/manifests/examples/{teads-curve.yml → pipelines/teads-curve.yml}

@@ -49,12 +49,13 @@ tree:
   children:
     child:
       pipeline:
-        - interpolate
-        - cpu-factor-to-wattage
-        - wattage-times-duration
-        - wattage-to-energy-kwh
-        - calculate-vcpu-ratio
-        - correct-cpu-energy-for-vcpu-ratio
+        compute:
+          - interpolate
+          - cpu-factor-to-wattage
+          - wattage-times-duration
+          - wattage-to-energy-kwh
+          - calculate-vcpu-ratio
+          - correct-cpu-energy-for-vcpu-ratio
       defaults:
         thermal-design-power: 100
         vcpus-total: 8

package/manifests/examples/{zeros.yaml → pipelines/zeros.yml}

@@ -106,22 +106,21 @@ tree:
   children:
     child-1:
       pipeline:
-        - sum-zero-and-one
-        - sum-zero-and-zero
-        - subtract-one-and-zero
-        - subtract-zero-and-zero
-        - subtract-zero-and-one
-        - coefficient-one-times-zero
-        - coefficient-zero-times-one
-        - coefficient-zero-times-zero
-        - multiply-one-times-zero
-        - multiply-zero-times-one
-        - exponent-one-to-zero
-        - exponent-zero-to-one
-        - exponent-zero-to-zero
-        - sci
-      config:
-      defaults:
+        compute:
+          - sum-zero-and-one
+          - sum-zero-and-zero
+          - subtract-one-and-zero
+          - subtract-zero-and-zero
+          - subtract-zero-and-one
+          - coefficient-one-times-zero
+          - coefficient-zero-times-one
+          - coefficient-zero-times-zero
+          - multiply-one-times-zero
+          - multiply-zero-times-one
+          - exponent-one-to-zero
+          - exponent-zero-to-one
+          - exponent-zero-to-zero
+          - sci
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
           duration: 1

package/manifests/outputs/bugs/aggregation-error-wrong-metric.yaml

@@ -0,0 +1,235 @@
+name: aggregation-error-wrong-metric
+description: >-
+  a negative test case that fails due to the aggregation feature being passed an
+  incorrect metric
+tags: null
+aggregation:
+  metrics:
+    - dummy-param
+  type: both
+initialize:
+  plugins:
+    interpolate:
+      method: Interpolation
+      path: builtin
+      global-config:
+        method: linear
+        x:
+          - 0
+          - 10
+          - 50
+          - 100
+        "y":
+          - 0.12
+          - 0.32
+          - 0.75
+          - 1.02
+        input-parameter: cpu/utilization
+        output-parameter: cpu-factor
+    cpu-factor-to-wattage:
+      method: Multiply
+      path: builtin
+      global-config:
+        input-parameters:
+          - cpu-factor
+          - cpu/thermal-design-power
+        output-parameter: cpu-wattage
+    wattage-times-duration:
+      method: Multiply
+      path: builtin
+      global-config:
+        input-parameters:
+          - cpu-wattage
+          - duration
+        output-parameter: cpu-wattage-times-duration
+    wattage-to-energy-kwh:
+      method: Divide
+      path: builtin
+      global-config:
+        numerator: cpu-wattage-times-duration
+        denominator: 3600000
+        output: cpu-energy-raw
+    calculate-vcpu-ratio:
+      method: Divide
+      path: builtin
+      global-config:
+        numerator: vcpus-total
+        denominator: vcpus-allocated
+        output: vcpu-ratio
+    correct-cpu-energy-for-vcpu-ratio:
+      method: Divide
+      path: builtin
+      global-config:
+        numerator: cpu-energy-raw
+        denominator: vcpu-ratio
+        output: cpu-energy-kwh
+    sci-embodied:
+      path: builtin
+      method: SciEmbodied
+    operational-carbon:
+      method: Multiply
+      path: builtin
+      global-config:
+        input-parameters:
+          - cpu-energy-kwh
+          - grid/carbon-intensity
+        output-parameter: carbon
+    sci:
+      path: builtin
+      method: Sci
+      global-config:
+        functional-unit: requests
+    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
+execution:
+  status: fail
+  command: >-
+    /Users/mariamkhalatova/.npm/_npx/1bf7c3c15bf47d04/node_modules/.bin/ts-node
+    /Users/mariamkhalatova/Projects/UK/if/src/index.ts -m
+    manifests/outputs/bugs/aggregation-error-wrong-metric.yml -o
+    manifests/outputs/bugs/aggregation-error-wrong-metric
+  environment:
+    if-version: 0.4.0
+    os: macOS
+    os-version: "13.2"
+    node-version: 18.14.2
+    date-time: 2024-07-01T19:25:34.759Z (UTC)
+    dependencies:
+      - "@babel/core@7.22.10"
+      - "@babel/preset-typescript@7.23.3"
+      - "@commitlint/cli@18.6.0"
+      - "@commitlint/config-conventional@18.6.0"
+      - "@grnsft/if-core@0.0.10"
+      - "@jest/globals@29.7.0"
+      - "@types/jest@29.5.8"
+      - "@types/js-yaml@4.0.9"
+      - "@types/luxon@3.4.2"
+      - "@types/node@20.9.0"
+      - axios-mock-adapter@1.22.0
+      - axios@1.7.2
+      - cross-env@7.0.3
+      - csv-parse@5.5.6
+      - csv-stringify@6.4.6
+      - fixpack@4.0.0
+      - gts@5.2.0
+      - husky@8.0.3
+      - jest@29.7.0
+      - js-yaml@4.1.0
+      - lint-staged@15.2.2
+      - luxon@3.4.4
+      - release-it@16.3.0
+      - rimraf@5.0.5
+      - ts-command-line-args@2.5.1
+      - ts-jest@29.1.1
+      - typescript-cubic-spline@1.0.1
+      - typescript@5.2.2
+      - winston@3.11.0
+      - zod@3.22.4
+  error: >-
+    MissingInputDataError: `functional-unit` value is missing from input data or it is not a positive integer
+tree:
+  children:
+    child-1:
+      pipeline:
+        regroup:
+          - cloud/region
+          - cloud/instance-type
+        compute:
+          - interpolate
+          - cpu-factor-to-wattage
+          - wattage-times-duration
+          - wattage-to-energy-kwh
+          - calculate-vcpu-ratio
+          - correct-cpu-energy-for-vcpu-ratio
+          - sci-embodied
+          - operational-carbon
+          - time-sync
+          - sci
+      defaults:
+        cpu/thermal-design-power: 100
+        grid/carbon-intensity: 800
+        device/emissions-embodied: 1533.12
+        time-reserved: 3600
+        device/expected-lifespan: 94608000
+        vcpus-allocated: 1
+        vcpus-total: 8
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          duration: 1
+          cpu/utilization: 10
+          requests: 100
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 20
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          requests: 100
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 15
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          requests: 100
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          cpu/utilization: 15
+          requests: 100
+    child-2:
+      pipeline:
+        regroup:
+          - cloud/region
+          - cloud/instance-type
+        compute:
+          - interpolate
+          - cpu-factor-to-wattage
+          - wattage-times-duration
+          - wattage-to-energy-kwh
+          - calculate-vcpu-ratio
+          - correct-cpu-energy-for-vcpu-ratio
+          - sci-embodied
+          - operational-carbon
+          - time-sync
+          - sci
+      defaults:
+        cpu/thermal-design-power: 100
+        grid/carbon-intensity: 800
+        device/emissions-embodied: 1533.12
+        time-reserved: 3600
+        device/expected-lifespan: 94608000
+        vcpus-allocated: 1
+        vcpus-total: 8
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          duration: 1
+          cpu/utilization: 30
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          requests: 100
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 28
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          requests: 100
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 40
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          requests: 100
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          cpu/utilization: 33
+          cloud/instance-type: A1
+          cloud/region: uk-west
+          requests: 100

package/manifests/outputs/bugs/input-error-missing-duration.yaml

@@ -0,0 +1,82 @@
+name: input-error-missing-duration
+description: >-
+  a negative test case that fails due to the required `duration` field being
+  omitted from input data
+tags: null
+initialize:
+  plugins:
+    interpolate:
+      method: Interpolation
+      path: builtin
+      global-config:
+        method: linear
+        x:
+          - 0
+          - 10
+          - 50
+          - 100
+        "y":
+          - 0.12
+          - 0.32
+          - 0.75
+          - 1.02
+        input-parameter: cpu/utilization
+        output-parameter: cpu-factor
+execution:
+  status: fail
+  command: >-
+    /Users/mariamkhalatova/.npm/_npx/1bf7c3c15bf47d04/node_modules/.bin/ts-node
+    /Users/mariamkhalatova/Projects/UK/if/src/index.ts -m
+    manifests/outputs/bugs/input-error-missing-duration.yml -o
+    manifests/outputs/bugs/input-error-missing-duration
+  environment:
+    if-version: 0.4.0
+    os: macOS
+    os-version: "13.2"
+    node-version: 18.14.2
+    date-time: 2024-07-01T19:59:58.987Z (UTC)
+    dependencies:
+      - "@babel/core@7.22.10"
+      - "@babel/preset-typescript@7.23.3"
+      - "@commitlint/cli@18.6.0"
+      - "@commitlint/config-conventional@18.6.0"
+      - "@grnsft/if-core@0.0.10"
+      - "@jest/globals@29.7.0"
+      - "@types/jest@29.5.8"
+      - "@types/js-yaml@4.0.9"
+      - "@types/luxon@3.4.2"
+      - "@types/node@20.9.0"
+      - axios-mock-adapter@1.22.0
+      - axios@1.7.2
+      - cross-env@7.0.3
+      - csv-parse@5.5.6
+      - csv-stringify@6.4.6
+      - fixpack@4.0.0
+      - gts@5.2.0
+      - husky@8.0.3
+      - jest@29.7.0
+      - js-yaml@4.1.0
+      - lint-staged@15.2.2
+      - luxon@3.4.4
+      - release-it@16.3.0
+      - rimraf@5.0.5
+      - ts-command-line-args@2.5.1
+      - ts-jest@29.1.1
+      - typescript-cubic-spline@1.0.1
+      - typescript@5.2.2
+      - winston@3.11.0
+      - zod@3.22.4
+  error: >-
+    InputValidationError: "duration" parameter is required at index 0. Error
+    code: invalid_type.
+tree:
+  children:
+    child-0:
+      defaults:
+        cpu/thermal-design-power: 100
+      pipeline:
+        compute:
+          - interpolate
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          cpu/utilization: 20

package/manifests/outputs/bugs/mock-observations-failure-duration-is-zero.yaml

@@ -0,0 +1,79 @@
+name: mock-observation-demo
+description: a manifest demonstrating how to use the mock observations feature
+tags: null
+initialize:
+  plugins:
+    mock-observations:
+      kind: plugin
+      method: MockObservations
+      path: builtin
+      global-config:
+        timestamp-from: 2023-07-06T00:00
+        timestamp-to: 2023-07-06T00:10
+        duration: 0
+        components:
+          - cloud/instance-type: A1
+          - cloud/instance-type: B1
+        generators:
+          common:
+            region: uk-west
+            common-key: common-val
+          randint:
+            cpu/utilization:
+              min: 1
+              max: 99
+            memory/utilization:
+              min: 1
+              max: 99
+execution:
+  status: fail
+  command: >-
+    /Users/mariamkhalatova/.npm/_npx/1bf7c3c15bf47d04/node_modules/.bin/ts-node
+    /Users/mariamkhalatova/Projects/UK/if/src/index.ts -m
+    manifests/outputs/bugs/mock-observations-failure-duration-is-zero.yml -o
+    manifests/outputs/bugs/mock-observations-failure-duration-is-zero
+  environment:
+    if-version: 0.4.0
+    os: macOS
+    os-version: "13.2"
+    node-version: 18.14.2
+    date-time: 2024-07-01T20:02:22.596Z (UTC)
+    dependencies:
+      - "@babel/core@7.22.10"
+      - "@babel/preset-typescript@7.23.3"
+      - "@commitlint/cli@18.6.0"
+      - "@commitlint/config-conventional@18.6.0"
+      - "@grnsft/if-core@0.0.10"
+      - "@jest/globals@29.7.0"
+      - "@types/jest@29.5.8"
+      - "@types/js-yaml@4.0.9"
+      - "@types/luxon@3.4.2"
+      - "@types/node@20.9.0"
+      - axios-mock-adapter@1.22.0
+      - axios@1.7.2
+      - cross-env@7.0.3
+      - csv-parse@5.5.6
+      - csv-stringify@6.4.6
+      - fixpack@4.0.0
+      - gts@5.2.0
+      - husky@8.0.3
+      - jest@29.7.0
+      - js-yaml@4.1.0
+      - lint-staged@15.2.2
+      - luxon@3.4.4
+      - release-it@16.3.0
+      - rimraf@5.0.5
+      - ts-command-line-args@2.5.1
+      - ts-jest@29.1.1
+      - typescript-cubic-spline@1.0.1
+      - typescript@5.2.2
+      - winston@3.11.0
+      - zod@3.22.4
+  error: "InputValidationError: \"duration\" parameter is number must be greater than 0. Error code: too_small."
+tree:
+  children:
+    child:
+      pipeline:
+        observe:
+          - mock-observations
+      inputs: null