Local Development

Getting started

Requirements: To develop locally, you will first need to install node js in order to install dependencies, test, build, and deploy the extension.

  1. First clone the IBM Operator Collection SDK VS Code Extension repository on github:
      git clone https://github.com/IBM/operator-collection-sdk-vscode-extension.git \
&& cd operator-collection-sdk-vscode-extension
  2. Install the extension dependencies:
      npm install

Explore the API

  • You can open the full set of our API when you open the file node_modules/@types/vscode/index.d.ts.

Making changes

  • You can launch the extension from the debug toolbar after changing code in src/extension.ts.
  • You can also reload (Ctrl+R or Cmd+R on Mac) the VS Code window with your extension to load your changes.

Debugging

  • Press F5 to open a new window with your extension loaded.
  • Run your command from the command palette by pressing (Ctrl+Shift+P or Cmd+Shift+P on Mac) and typing Hello World.
  • Set breakpoints in your code inside src/extension.ts to debug your extension.
  • Find output from your extension in the debug console.

Run tests

Running tests in terminal

  • Run the oc login command to log in to an OpenShift® cluster, and validate you’re in the correct project.
  • Run the following command to execute tests.
  npm run test

Running tests in VS Code

  • Open the debug viewlet (Ctrl+Shift+D or Cmd+Shift+D on Mac) and from the launch configuration dropdown pick Extension Tests.
  • Press F5 to run the tests in a new window with your extension loaded.
  • See the output of the test result in the debug console.

Executing Tests using GitHub Workflows

Since the current tests require access to an OpenShift cluster, you are required to configure the following variables in your workspace before successfully executing an end to end test of your changes.

  • Navigate to Setting > Secrets and variables > Actions and click the “New repository secret” button GitHub Settings
  • Configure the OCP_SERVER_URL secret. This value can be retrieved and set using the following command:
      oc config view --minify -o jsonpath='{.clusters[*].cluster.server}'
  • Generate a new Service Account token in OpenShift and configure the OCP_TOKEN secret in GitHub. Follow the steps below to generate a token with the proper access in the cluster
      saName=github
oc create sa ${saName} -n default
oc adm policy add-cluster-role-to-user cluster-admin -z ${saName} -n default
oc sa new-token ${saName} -n default

Local builds

  1. Build the .vsix file (the extension dependencies must already be installed):
      npm run build
  2. Deploy the extension to your VS Code editor:
      npm run deploy