Vscode extension #1404

eravatee · 2022-07-12T01:24:23Z

The primary body of work to setup a vscode extension for caliper.
It introduces a json schema to assist users in creating a runtime configuration for caliper

To run the extension:

Compile the code by using : npm run compile
Execute the extension from VS code by running the file: extension.js

aklenik

Besides the comments embedded in the files, I have the following general remarks:

The package directory name should be caliper-vscode-extension
This directory should be the package's root, so no other extension subdirectory is needed.
The schema files should go into the caliper-vscode-extension/artifacts/schemas directory. We might have different types of artifacts later on.
The schema file names should be more descriptive (their length doesn't matter, users will rarely type it themselves):
1. benchmark.json -> hyperledger-caliper-benchmark-confguration-schema.json
2. default.json -> hyperledger-caliper-runtime-configuration-schema.json
3. fabric.json -> hyperledger-caliper-fabric-network-configuration-schema.json
4. ethereum-besu.json -> hyperledger-caliper-ethereum-network-configuration-schema.json
You should check whether the current configuration files used by the CI pipeline (in packages/caliper-tests-integration) pass the schema validation. Those configs cover a lot of different use cases, so until we don't have proper unit tests for the schemas, such smoke tests can help.
Since the extension only registers schemas, we won't have any TS source files in the PR for now. So every unrelated sources can be removed from the PR.
For starters, I suggest keeping only the runtime configuration schema for this PR. The other schemas are more complicated, and even the runtime schema is incomplete regarding descriptions.

packages/caliper-vscode/extension/package.json

aklenik · 2022-07-19T12:15:53Z

packages/caliper-vscode/extension/package.json

+{
+  "name": "caliper-vscode-extension",
+	"displayName": "caliper-vscode-extension",
+	"description": "",


This should be filled with a single, short, descriptive sentence about the extension. Look up some extensions in vscode to get a sense of what kinds of descriptions should be used.

packages/caliper-vscode/extension/package.json

aklenik · 2022-07-19T12:30:59Z

packages/caliper-vscode/extension/tsconfig.json

@@ -0,0 +1,17 @@
+{


This should extend the available Node14 base:

How-to: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html#tsconfig-bases

Needed package: @tsconfig/node14

Content of base file: https://github.com/tsconfig/bases/blob/main/bases/node14.json

packages/caliper-vscode/extension/CHANGELOG.md

aklenik · 2022-07-19T12:33:14Z

packages/caliper-vscode/extension/.eslintrc.json

@@ -0,0 +1,24 @@
+{


You should reuse the eslintrc file content from one of the other packages, like caliper-core, so it's in sync with the other packages

aklenik · 2022-07-19T12:39:17Z

packages/caliper-vscode/artifacts/benchmark.json

+                                        "description": "The number of TXs Caliper should submit during the round.",
+                                        "type": "integer"
+                                    },
+                                    "rateControl": {


Depending on the value of type, the opts object can be different. I'd suggest exploring conditional schemas to handle such cases flexibly: https://json-schema.org/understanding-json-schema/reference/conditionals.html#if-then-else
This will require a newer JSON schema version, but vscode supports even the newest draft, so I'd suggest that every schema should use that newest draft.

codecov · 2022-08-24T18:21:48Z

Codecov Report

❗ No coverage uploaded for pull request base (main@8a792e0). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1404   +/-   ##
=======================================
  Coverage        ?   55.56%           
=======================================
  Files           ?      103           
  Lines           ?     4451           
  Branches        ?      676           
=======================================
  Hits            ?     2473           
  Misses          ?     1435           
  Partials        ?      543

Flag	Coverage Δ
caliper-core	`44.31% <0.00%> (?)`
caliper-fabric	`80.46% <0.00%> (?)`
generator-caliper	`83.62% <0.00%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

aklenik

There are still some unresolved remarks or solutions that don't follow the suggested approaches (eslint, tsconfig contents, left-over out-of-scope schemas). Please resolve these systematically.

aklenik · 2022-08-26T11:04:41Z

...extension/artifacts/json-schema/hyperledger-caliper-fabric-network-configuration.schema.json

@@ -0,0 +1,350 @@
+{


For now, let's remove this schema from the PR. Let's focus only on the runtime configuration schema.

aklenik · 2022-08-26T11:05:20Z

...on/artifacts/json-schema/hyperledger-caliper-ethereum-network-configuration.schema.json.json

@@ -0,0 +1,129 @@
+{


For now, let's remove this schema from the PR. Let's focus only on the runtime configuration schema.

aklenik · 2022-08-26T11:05:28Z

...code-extension/artifacts/json-schema/hyperledger-caliper-benchmark-configuration.schema.json

@@ -0,0 +1,313 @@
+{


For now, let's remove this schema from the PR. Let's focus only on the runtime configuration schema.

aklenik · 2022-08-26T11:19:24Z

...vscode-extension/artifacts/json-schema/hyperledger-caliper-runtime-configuration.schema.json

+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "caliper": {


Every root/middle/leaf property must have a user-friendly description, summarizing the property(group) as precisely as possible

Signed-off-by: eravatee <eraraje1997@gmail.com>

* Migrate Fabric integration tests to test network Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> * Address review comments * Get rid of `rm -fr /tmp/hfc-*` * Merge redundant phases * Upgrade SUT version in docker tests * Remove unnecessary connection profiles * Made `discover = true` Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> * Address review comments * Add connection profiles wherever needed Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

- remove fabric-protos as not needed due to removal of fabric operations code - update to latest 2.2 sdk which addresses discovery bug under load Signed-off-by: D <d_kelsey@uk.ibm.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

* Migrate to npm workspaces Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> * Address review comments * Fix npm version in GitHub Actions Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> * Address review comments * Define NPM version once in workflow * Add script for checking prerequisites Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

Signed-off-by: eravatee <eraraje1997@gmail.com>

* Cache node modules across CI workflows Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> * Address review comments * Change name of step in integration test workflow * Remove unnecessary directory creation Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> * Address review comments * Add comments * Remove Fabric 2.4 from cache Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> * Address review comments * Fix documentation Co-authored-by: Dave Kelsey <d_kelsey@uk.ibm.com> Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> Co-authored-by: Dave Kelsey <d_kelsey@uk.ibm.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

* Execute integration tests based on changes Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> * Trigger fabric tests Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> * Trigger ethereum tests Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> * Trigger fisco-bcos tests Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> * Trigger through core changes Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> * Make change that shouldn't trigger any integration tests Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> * Address review comments * Fix edge case with empty matrix Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

…dger#1425) This reverts commit 954eba5. Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

…1427) * Distinguish different workers in Prometheus PushGateway Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> * Address review comments * Remove redundant labels * Add roundIndex to groupings * Update unit tests utilizing workerIndex and roundIndex * Write new unit test for _sendUpdate Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

Signed-off-by: eravatee <eraraje1997@gmail.com>

…1404) * JSON schema file for runtime configuration validations * Basic skeleton for vscode extension to implement further JSON schemas and UI elements Signed-off-by: eravatee <eraraje1997@gmail.com>

eravatee closed this Jul 14, 2022

eravatee reopened this Jul 14, 2022

eravatee force-pushed the vscode-extension branch 2 times, most recently from c4de12d to e662c83 Compare July 14, 2022 20:14

aklenik requested changes Jul 19, 2022

View reviewed changes

aklenik mentioned this pull request Jul 19, 2022

added json schema files for configuration validations #1405

Closed

9 tasks

aklenik requested changes Aug 26, 2022

View reviewed changes

eravatee and others added 18 commits October 1, 2022 14:36

added json schema files for configuration validations

88ee1e1

Signed-off-by: eravatee <eraraje1997@gmail.com>

basic skeleton for vscode extension to implement designed json schemas

4f5ac94

Signed-off-by: eravatee <eraraje1997@gmail.com>

Remove channel and chaincode ops from Fabric v1 (hyperledger#1411)

d11a262

Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

update fabric bindings (hyperledger#1412)

d5c45fd

- remove fabric-protos as not needed due to removal of fabric operations code - update to latest 2.2 sdk which addresses discovery bug under load Signed-off-by: D <d_kelsey@uk.ibm.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

Migrate generator tests to test network (hyperledger#1414)

07f61af

Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

cosmetic changes to fix directory structure

09ae49a

Signed-off-by: eravatee <eraraje1997@gmail.com>

remove extension folder

b6658cf

Signed-off-by: eravatee <eraraje1997@gmail.com>

added changes to pick yaml validation files

b04eda7

Signed-off-by: eravatee <eraraje1997@gmail.com>

Add workflow for gh-pages branch (hyperledger#1423)

0ce03ec

Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

Revert "Add workflow for gh-pages branch (hyperledger#1423)" (hyperle…

798d2c8

…dger#1425) This reverts commit 954eba5. Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

Add coverage report workflow (hyperledger#1428)

f620ee5

Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

Upload coverage reports on merge (hyperledger#1433)

bf2b51a

Signed-off-by: CaptainIRS <36656347+CaptainIRS@users.noreply.github.com> Signed-off-by: eravatee <eraraje1997@gmail.com>

Added updates to runtime config

9902458

Signed-off-by: eravatee <eraraje1997@gmail.com>

eravatee force-pushed the vscode-extension branch from aae171d to 9902458 Compare October 1, 2022 20:37

aklenik approved these changes Oct 3, 2022

View reviewed changes

aklenik merged commit 69000d4 into hyperledger:main Oct 3, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Vscode extension #1404

Vscode extension #1404

eravatee commented Jul 12, 2022 •

edited

Loading

aklenik left a comment

aklenik Jul 19, 2022

aklenik Jul 19, 2022

aklenik Jul 19, 2022

aklenik Jul 19, 2022

codecov bot commented Aug 24, 2022 •

edited

Loading

aklenik left a comment

aklenik Aug 26, 2022

aklenik Aug 26, 2022

aklenik Aug 26, 2022

aklenik Aug 26, 2022

Vscode extension #1404

Vscode extension #1404

Conversation

eravatee commented Jul 12, 2022 • edited Loading

aklenik left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Aug 24, 2022 • edited Loading

Codecov Report

aklenik left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eravatee commented Jul 12, 2022 •

edited

Loading

codecov bot commented Aug 24, 2022 •

edited

Loading