@grnsft/if 0.4.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,14 +1,16 @@
 {
   "name": "@grnsft/if",
   "description": "Impact Framework",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "author": {
     "name": "Green Software Foundation",
     "email": "info@gsf.com"
   },
   "bin": {
-    "ie": "./build/index.js",
-    "if-diff": "./build/diff.js"
+    "if-diff": "./build/diff.js",
+    "if-run": "./build/index.js",
+    "if-env": "./build/env.js",
+    "if-check": "./build/check.js"
   },
   "bugs": {
     "url": "https://github.com/Green-Software-Foundation/if/issues/new?assignees=&labels=feedback&projects=&template=feedback.md&title=Feedback+-+"
@@ -16,6 +18,7 @@
   "dependencies": {
     "@commitlint/cli": "^18.6.0",
     "@commitlint/config-conventional": "^18.6.0",
+    "@grnsft/if-core": "^0.0.10",
     "axios": "^1.7.2",
     "csv-parse": "^5.5.6",
     "csv-stringify": "^6.4.6",
@@ -36,6 +39,7 @@
     "@types/luxon": "^3.4.2",
     "@types/node": "^20.8.9",
     "axios-mock-adapter": "^1.22.0",
+    "cross-env": "7.0.3",
     "fixpack": "^4.0.0",
     "gts": "^5.0.0",
     "husky": "^8.0.0",
@@ -72,8 +76,10 @@
     "coverage": "jest --verbose --coverage --testPathPattern=src/__tests__/unit",
     "fix": "gts fix",
     "fix:package": "fixpack",
-    "ie": "npx ts-node src/index.ts",
+    "if-check": "cross-env CURRENT_DIR=$(node -p \"process.env.INIT_CWD\") npx ts-node src/check.ts",
     "if-diff": "npx ts-node src/diff.ts",
+    "if-env": "cross-env CURRENT_DIR=$(node -p \"process.env.INIT_CWD\") npx ts-node src/env.ts",
+    "if-run": "npx ts-node src/index.ts",
     "lint": "gts lint",
     "pre-commit": "lint-staged",
     "prepare": "husky install",

package/src/__mocks__/mock-manifest.yaml

@@ -0,0 +1,72 @@
+name: template manifest
+description: auto-generated template
+tags: null
+initialize:
+  plugins:
+    memory-energy-from-memory-util:
+      path: builtin
+      method: Coefficient
+      global-config:
+        input-parameter: memory/utilization
+        coefficient: 0.0001
+        output-parameter: memory/energy
+  outputs:
+    - yaml
+execution:
+  command: >-
+    /Users/manushak/.npm/_npx/1bf7c3c15bf47d04/node_modules/.bin/ts-node
+    /Users/manushak/Documents/Projects/Green-Software/if/src/index.ts -m
+    ./src/env-template.yml -o ./manifests/outputs/template
+  environment:
+    if-version: 0.4.0
+    os: macOS
+    os-version: 13.6.6
+    node-version: 20.12.2
+    date-time: 2024-06-18T08:39:55.771Z (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.3"
+      - "@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:
+        - memory-energy-from-memory-util
+      config: null
+      inputs:
+        - timestamp: 2023-12-12T00:00:00.000Z
+          duration: 3600
+          memory/utilization: 10
+      outputs:
+        - timestamp: 2023-12-12T00:00:00.000Z
+          duration: 3600
+          memory/utilization: 10
+          memory/energy: 0.001

package/src/builtins/README.md

@@ -305,7 +305,7 @@ Then, you must select the metric you want to export to CSV. The name of that met
 For example, to export the `carbon` data from your tree to a CSV file:
 
 ```sh
-ie --manifest example.yml --output example#carbon
+if-run --manifest example.yml --output example#carbon
 ```
 
 This will save a CSV file called `example.csv`. The contents will look similar to the following:

package/src/builtins/coefficient/README.md

@@ -86,7 +86,25 @@ tree:
 You can run this example by saving it as `./examples/manifests/coefficient.yml` and executing the following command from the project root:
 
 ```sh
-ie --manifest ./examples/manifests/coefficient.yml --output ./examples/outputs/coefficient.yml
+if-run --manifest ./examples/manifests/coefficient.yml --output ./examples/outputs/coefficient.yml
 ```
 
 The results will be saved to a new `yaml` file in `./examples/outputs`
+
+
+## Errors
+
+`Coefficient` exposes one of the IF error classes.
+
+### GlobalConfigError
+
+You will receive an error starting `GlobalConfigError: ` if you have not provided the expected configuration data in the plugin's `initialize` block.
+
+The required parameters are:
+- `input-parameter`: this must be a string
+- `coefficient`: this must be a number
+- `output-parameter`: this must be a string
+
+You can fix this error by checking you are providing valid values for each parameter in the config.
+
+For more information on our error classes, please visit [our docs](https://if.greensoftware.foundation/reference/errors