@grnsft/if 0.5.0-beta.0 → 0.5.0

package/manifests/outputs/plugins/sum/failure-missing-input-param.yaml

@@ -0,0 +1,75 @@
+name: sum
+description: failure with `inputs[0]` misses one of `global-config.input-parameters`
+tags: null
+initialize:
+  outputs:
+    - yaml
+  plugins:
+    sum:
+      method: Sum
+      path: builtin
+      global-config:
+        input-parameters:
+          - cpu/energy
+          - network/energy
+        output-parameter: energy
+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/plugins/sum/failure-missing-input-param.yml -o
+    manifests/outputs/plugins/sum/failure-missing-input-param
+  environment:
+    if-version: 0.4.0
+    os: macOS
+    os-version: '13.2'
+    node-version: 18.14.2
+    date-time: 2024-07-02T20:55:20.733Z (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: "cpu/energy" parameter is required. Error code:
+    invalid_type.
+tree:
+  children:
+    child:
+      pipeline:
+        - sum
+      config:
+        sum: null
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu: 0.001
+          network/energy: 0.001

package/manifests/outputs/plugins/sum/failure-missing-output-param.yaml

@@ -0,0 +1,78 @@
+name: sum
+description: missing `output-parameter` in global-config
+tags: null
+initialize:
+  outputs:
+    - yaml
+  plugins:
+    sum:
+      method: Sum
+      path: builtin
+      global-config:
+        input-parameters:
+          - cpu/energy
+          - network/energy
+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/plugins/sum/failure-missing-output-param.yml -o
+    manifests/outputs/plugins/sum/failure-missing-output-param
+  environment:
+    if-version: 0.4.0
+    os: macOS
+    os-version: '13.2'
+    node-version: 18.14.2
+    date-time: 2024-07-02T20:54:23.422Z (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: "output-parameter" parameter is required. Error code:
+    invalid_type.
+tree:
+  children:
+    child:
+      pipeline:
+        - sum
+      config:
+        sum: null
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu/energy: 0.001
+          network/energy: 0.001
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu/energy: 0.001
+          network/energy: e

package/manifests/outputs/plugins/sum/success.yaml

@@ -0,0 +1,78 @@
+name: sum
+description: successful path
+tags: null
+initialize:
+  plugins:
+    sum:
+      path: builtin
+      method: Sum
+      global-config:
+        input-parameters:
+          - cpu/energy
+          - network/energy
+        output-parameter: energy
+  outputs:
+    - yaml
+execution:
+  command: >-
+    /Users/mariamkhalatova/.npm/_npx/1bf7c3c15bf47d04/node_modules/.bin/ts-node
+    /Users/mariamkhalatova/Projects/UK/if/src/index.ts -m
+    manifests/outputs/plugins/sum/success.yml -o
+    manifests/outputs/plugins/sum/success
+  environment:
+    if-version: 0.4.0
+    os: macOS
+    os-version: '13.2'
+    node-version: 18.14.2
+    date-time: 2024-07-02T20:53:35.496Z (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
+  status: success
+tree:
+  children:
+    child:
+      pipeline:
+        - sum
+      config:
+        sum: null
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu/energy: 0.001
+          network/energy: 0.001
+      outputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          cpu/energy: 0.001
+          network/energy: 0.001
+          energy: 0.002

package/manifests/outputs/plugins/time-sync/failure-config-start-later-end.yaml

@@ -0,0 +1,82 @@
+name: time-sync
+description: >-
+  failure with `global-config.start-time` being later than
+  `global-config.end-time`
+tags: null
+initialize:
+  outputs:
+    - yaml
+  plugins:
+    time-sync:
+      method: TimeSync
+      path: builtin
+      global-config:
+        start-time: '2023-12-12T00:01:00.000Z'
+        end-time: '2023-12-12T00:00: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/plugins/time-sync/failure-config-start-later-end.yml -o
+    manifests/outputs/plugins/time-sync/failure-config-start-later-end
+  environment:
+    if-version: 0.4.0
+    os: macOS
+    os-version: '13.2'
+    node-version: 18.14.2
+    date-time: 2024-07-02T21:13:59.114Z (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: `start-time` should be lower than `end-time`'
+tree:
+  children:
+    child:
+      pipeline:
+        - time-sync
+      config: null
+      inputs:
+        - timestamp: '2023-12-12T00:00:00.000Z'
+          duration: 1
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:01.000Z'
+          duration: 5
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:06.000Z'
+          duration: 7
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:13.000Z'
+          duration: 30
+          energy-cpu: 0.001

package/manifests/outputs/plugins/time-sync/failure-missing-global-config.yaml

@@ -0,0 +1,78 @@
+name: time-sync
+description: missing global config
+tags: null
+initialize:
+  outputs:
+    - yaml
+  plugins:
+    time-sync:
+      method: TimeSync
+      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/plugins/time-sync/failure-missing-global-config.yml -o
+    manifests/outputs/plugins/time-sync/failure-missing-global-config
+  environment:
+    if-version: 0.4.0
+    os: macOS
+    os-version: '13.2'
+    node-version: 18.14.2
+    date-time: 2024-07-02T21:13:12.360Z (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.time-sync.global-config"
+    parameter is expected object, received null. Error code: invalid_type.
+tree:
+  children:
+    child:
+      pipeline:
+        - time-sync
+      config: null
+      inputs:
+        - timestamp: '2023-12-12T00:00:00.000Z'
+          duration: 3
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:01.000Z'
+          duration: 5
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:06.000Z'
+          duration: 7
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:13.000Z'
+          duration: 30
+          energy-cpu: 0.001

package/manifests/outputs/plugins/time-sync/success.yaml

@@ -0,0 +1,119 @@
+name: time-sync
+description: successful path
+tags: null
+initialize:
+  plugins:
+    time-sync:
+      path: builtin
+      method: TimeSync
+      global-config:
+        start-time: '2023-12-12T00:00:00.000Z'
+        end-time: '2023-12-12T00:01:00.000Z'
+        interval: 5
+        allow-padding: true
+  outputs:
+    - yaml
+execution:
+  command: >-
+    /Users/mariamkhalatova/.npm/_npx/1bf7c3c15bf47d04/node_modules/.bin/ts-node
+    /Users/mariamkhalatova/Projects/UK/if/src/index.ts -m
+    manifests/outputs/plugins/time-sync/success.yml -o
+    manifests/outputs/plugins/time-sync/success -s
+  environment:
+    if-version: 0.4.0
+    os: macOS
+    os-version: '13.2'
+    node-version: 18.14.2
+    date-time: 2024-07-02T21:12:32.629Z (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
+  status: success
+tree:
+  children:
+    child:
+      pipeline:
+        - time-sync
+      config: null
+      inputs:
+        - timestamp: '2023-12-12T00:00:00.000Z'
+          duration: 1
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:01.000Z'
+          duration: 5
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:06.000Z'
+          duration: 7
+          energy-cpu: 0.001
+        - timestamp: '2023-12-12T00:00:13.000Z'
+          duration: 30
+          energy-cpu: 0.001
+      outputs:
+        - timestamp: '2023-12-12T00:00:00.000Z'
+          duration: 5
+          energy-cpu: 0.0018000000000000004
+        - timestamp: '2023-12-12T00:00:05.000Z'
+          duration: 5
+          energy-cpu: 0.0007714285714285716
+        - timestamp: '2023-12-12T00:00:10.000Z'
+          duration: 5
+          energy-cpu: 0.0004952380952380952
+        - timestamp: '2023-12-12T00:00:15.000Z'
+          duration: 5
+          energy-cpu: 0.0001666666666666667
+        - timestamp: '2023-12-12T00:00:20.000Z'
+          duration: 5
+          energy-cpu: 0.0001666666666666667
+        - timestamp: '2023-12-12T00:00:25.000Z'
+          duration: 5
+          energy-cpu: 0.0001666666666666667
+        - timestamp: '2023-12-12T00:00:30.000Z'
+          duration: 5
+          energy-cpu: 0.0001666666666666667
+        - timestamp: '2023-12-12T00:00:35.000Z'
+          duration: 5
+          energy-cpu: 0.0001666666666666667
+        - timestamp: '2023-12-12T00:00:40.000Z'
+          duration: 5
+          energy-cpu: 0.0001
+        - timestamp: '2023-12-12T00:00:45.000Z'
+          duration: 5
+          energy-cpu: 0
+        - timestamp: '2023-12-12T00:00:50.000Z'
+          duration: 5
+          energy-cpu: 0
+        - timestamp: '2023-12-12T00:00:55.000Z'
+          duration: 5
+          energy-cpu: 0
+        - timestamp: '2023-12-12T00:01:00.000Z'
+          duration: 1
+          energy-cpu: 0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@grnsft/if",
   "description": "Impact Framework",
-  "version": "0.5.0-beta.0",
+  "version": "0.5.0",
   "author": {
     "name": "Green Software Foundation",
     "email": "info@gsf.com"

package/manifests/bugs/aggregation-error-wrong-metric.yml

@@ -1,178 +0,0 @@
-name: aggregation-error-wrong-metric
-description: a negative test case that fails due to the aggregation feature being passed an incorrect metric
-tags:
-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
-    "group-by":
-      path: builtin
-      method: GroupBy
-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.120 # gCO2eq
-        time-reserved: 3600 # 1hr in seconds
-        device/expected-lifespan: 94608000 # 3 years in seconds
-        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.120 # gCO2eq
-        time-reserved: 3600 # 1hr in seconds
-        device/expected-lifespan: 94608000 # 3 years in seconds
-        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