@grnsft/if 0.4.0 → 0.5.0

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

@@ -25,20 +25,57 @@ initialize:
             cpu/utilization:
               min: 1
               max: 99
-    "teads-curve":
-      path: "@grnsft/if-unofficial-plugins"
-      method: TeadsCurve
+    "interpolate":
+      method: Interpolation
+      path: 'builtin'
       global-config:
-        interpolation: spline
-    "sci-e":
-      path: "@grnsft/if-plugins"
-      method: SciE
+        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
-    "sci-o":
-      path: "@grnsft/if-plugins"
-      method: SciO
+    "operational-carbon":
+      method: Multiply
+      path: builtin
+      global-config:
+        input-parameters: ["cpu-energy-kwh", "grid/carbon-intensity"]
+        output-parameter: "carbon-operational"
     "sum-carbon":
       path: "builtin"
       method: Sum
@@ -68,10 +105,14 @@ tree:
   children:
     child-1:
       pipeline:
-        - teads-curve
-        - sci-e
+        - interpolate
+        - cpu-factor-to-wattage
+        - wattage-times-duration
+        - wattage-to-energy-kwh
+        - calculate-vcpu-ratio
+        - correct-cpu-energy-for-vcpu-ratio
         - sci-embodied
-        - sci-o
+        - operational-carbon
         - sum-carbon
         - time-sync
         - sci
@@ -86,9 +127,8 @@ tree:
         device/emissions-embodied: 1533.120 # gCO2eq
         time-reserved: 3600 # 1hr in seconds
         device/expected-lifespan: 94608000 # 3 years in seconds
-        resources-reserved: 1
-        resources-total: 8
-        functional-unit-time: "1 min"
+        vcpus-total: 8
+        vcpus-allocated: 1
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
           cloud/instance-type: A1
@@ -116,10 +156,14 @@ tree:
           requests: 50
     child-2:
       pipeline:
-        - teads-curve
-        - sci-e
+        - interpolate
+        - cpu-factor-to-wattage
+        - wattage-times-duration
+        - wattage-to-energy-kwh
+        - calculate-vcpu-ratio
+        - correct-cpu-energy-for-vcpu-ratio
         - sci-embodied
-        - sci-o
+        - operational-carbon
         - sum-carbon
         - time-sync
         - sci
@@ -134,9 +178,8 @@ tree:
         device/emissions-embodied: 1533.120 # gCO2eq
         time-reserved: 3600 # 1hr in seconds
         device/expected-lifespan: 94608000 # 3 years in seconds
-        resources-reserved: 1
-        resources-total: 8
-        functional-unit-time: "1 min"
+        vcpus-total: 8
+        vcpus-allocated: 1
       inputs:
         - timestamp: "2023-12-12T00:00:00.000Z"
           duration: 1

package/manifests/examples/pipelines/zeros.yml

@@ -0,0 +1,130 @@
+name: generics
+description: a pipeline that does arbitrary calculations using our generic arithmetic builtins
+tags:
+initialize:
+  plugins:
+    "sum-zero-and-one":
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - some-value
+          - zero-value
+        output-parameter: one-plus-zero
+    "sum-zero-and-zero":
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - zero-value
+          - zero-value
+        output-parameter: zero-plus-zero
+    "subtract-one-and-zero":
+      path: "builtin"
+      method: Subtract
+      global-config:
+        input-parameters:
+          - some-value
+          - zero-value
+        output-parameter: one-minus-zero
+    "subtract-zero-and-zero":
+      path: "builtin"
+      method: Sum
+      global-config:
+        input-parameters:
+          - zero-value
+          - zero-value
+        output-parameter: zero-minus-zero
+    "subtract-zero-and-one":
+      path: "builtin"
+      method: Subtract
+      global-config:
+        input-parameters:
+          - zero-value
+          - some-value
+        output-parameter: zero-minus-one
+    "coefficient-one-times-zero":
+      path: "builtin"
+      method: Coefficient
+      global-config:
+        input-parameter: zero-value
+        coefficient: 1
+        output-parameter: zero-times-one-coefficient
+    "coefficient-zero-times-one":
+      path: "builtin"
+      method: Coefficient
+      global-config:
+        input-parameter: some-value
+        coefficient: 0
+        output-parameter: one-times-zero-coefficient
+    "coefficient-zero-times-zero":
+      path: "builtin"
+      method: Coefficient
+      global-config:
+        input-parameter: zero-value
+        coefficient: 0
+        output-parameter: zero-times-zero-coefficient
+    "multiply-one-times-zero":
+      path: "builtin"
+      method: Multiply
+      global-config:
+        input-parameters: ["some-value", "zero-value"]
+        output-parameter: "one-times-zero"
+    "multiply-zero-times-one":
+      path: "builtin"
+      method: Multiply
+      global-config:
+        input-parameters: ["zero-value", "zero-value"]
+        output-parameter: "zero-times-one"
+    exponent-one-to-zero:
+      method: Exponent
+      path: 'builtin'
+      global-config:
+        input-parameter: 'some-value'
+        exponent: 0
+        output-parameter: 'one-raised-to-zero-power'
+    exponent-zero-to-zero:
+      method: Exponent
+      path: 'builtin'
+      global-config:
+        input-parameter: 'zero-value'
+        exponent: 0
+        output-parameter: 'zero-raised-to-zero-power'
+    exponent-zero-to-one:
+      method: Exponent
+      path: 'builtin'
+      global-config:
+        input-parameter: 'zero-value'
+        exponent: 1
+        output-parameter: 'zero-raised-to-first-power'
+    "sci":
+      path: "builtin"
+      method: Sci
+      global-config:
+        functional-unit: "zero-value"
+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:
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          duration: 1
+          some-value: 1
+          zero-value: 0
+          carbon: 10

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

@@ -0,0 +1,243 @@
+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:
+  outputs:
+    - yaml
+  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
+    group-by:
+      path: builtin
+      method: GroupBy
+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: >-
+    MissingAggregationParamError: Aggregation metric dummy-param is not found in
+    inputs[0].
+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
+        - sci-embodied
+        - operational-carbon
+        - time-sync
+        - sci
+      config:
+        group-by:
+          group:
+            - cloud/region
+            - cloud/instance-type
+      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:
+        - 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
+      config:
+        group-by:
+          group:
+            - cloud/region
+            - cloud/instance-type
+      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/initialize-error-no-config.yaml

@@ -0,0 +1,78 @@
+name: initialize-error-no-config
+description: >-
+  a negative test case that fails due to plugin initialization missing some
+  required config
+tags: null
+initialize:
+  outputs:
+    - yaml
+  plugins:
+    interpolate:
+      method: Interpolation
+      path: builtin
+      global-config: null
+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/initialize-error-no-config.yml -o
+    manifests/outputs/bugs/initialize-error-no-config
+  environment:
+    if-version: 0.4.0
+    os: macOS
+    os-version: '13.2'
+    node-version: 18.14.2
+    date-time: 2024-07-01T19:45:41.936Z (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: >-
+    ManifestValidationError: "initialize.plugins.interpolate.global-config"
+    parameter is expected object, received null. Error code: invalid_type.
+tree:
+  children:
+    child-0:
+      defaults:
+        cpu/thermal-design-power: 100
+      pipeline:
+        - interpolate
+      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/outputs/bugs/initialize-error-no-path.yaml

@@ -0,0 +1,91 @@
+name: initialize-error-no-path
+description: >-
+  a negative test case that fails because the path is mising in a plugin
+  initialization
+tags: null
+initialize:
+  plugins:
+    interpolate:
+      method: Interpolation
+      path: null
+      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
+  outputs:
+    - yaml
+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/initialize-error-no-path.yml -o
+    manifests/outputs/bugs/initialize-error-no-path
+  environment:
+    if-version: 0.4.0
+    os: macOS
+    os-version: '13.2'
+    node-version: 18.14.2
+    date-time: 2024-07-01T19:57:11.499Z (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: >-
+    ManifestValidationError: "initialize.plugins.interpolate.path" parameter is
+    expected string, received null. Error code: invalid_type.
+tree:
+  children:
+    child-0:
+      defaults:
+        cpu/thermal-design-power: 100
+      pipeline:
+        - interpolate
+      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