Guarantee that master branch has "-dev" tag in version (microsoft#7477)

* Test this * Skip tests when running locally * Prep for microsoft#5908 (release* branches) * News file * Use require() * Forgot to update something lol * Add comment + undo microsoft#5908 change * Use application.ts * Review changes

Author: kimadeline

build/ci/templates/globals.yml

@@ -6,3 +6,4 @@ variables:
  MOCHA_REPORTER_JUNIT: true # Use the mocha-multi-reporters and send output to both console (spec) and JUnit (mocha-junit-reporter).
  VSC_PYTHON_FORCE_LOGGING: true # Enable this to turn on console output for the logger
  VSC_PYTHON_LOG_FILE: '$(Build.ArtifactStagingDirectory)/pvsc.log'
+ CI_BRANCH_NAME: ${Build.SourceBranchName}

news/3 Code Health/7471.md

@@ -0,0 +1 @@
+Add unit tests to guarantee that the extension version in the master branch has the '-dev' suffix.

src/test/extension.unit.test.ts

@@ -7,6 +7,8 @@
 
 import { expect } from 'chai';
 import { buildApi } from '../client/api';
+import { ApplicationEnvironment } from '../client/common/application/applicationEnvironment';
+import { IApplicationEnvironment } from '../client/common/application/types';
 import { EXTENSION_ROOT_DIR } from '../client/common/constants';
 
 const expectedPath = `${EXTENSION_ROOT_DIR.fileToCommandArgument()}/pythonFiles/ptvsd_launcher.py`;
@@ -23,3 +25,40 @@ suite('Extension API Debugger', () => {
  expect(args).to.be.deep.equal(expectedArgs);
  });
 });
+
+suite('Extension version tests', () => {
+ let version: string;
+ let applicationEnvironment: IApplicationEnvironment;
+ const branchName = process.env.CI_BRANCH_NAME;
+
+ suiteSetup(async function() {
+ // Skip the entire suite if running locally
+ if (!branchName) {
+ // tslint:disable-next-line: no-invalid-this
+ return this.skip();
+ }
+ });
+
+ setup(() => {
+ applicationEnvironment = new ApplicationEnvironment(undefined as any, undefined as any, undefined as any);
+ version = applicationEnvironment.packageJson.version;
+ });
+
+ test('If we are running a pipeline in the master branch, the extension version in `package.json` should have the "-dev" suffix', async function() {
+ if (branchName !== 'master') {
+ // tslint:disable-next-line: no-invalid-this
+ return this.skip();
+ }
+
+ return expect(version.endsWith('-dev'), 'When running a pipeline in the master branch, the extension version in package.json should have the -dev suffix').to.be.true;
+ });
+
+ test('If we are running a pipeline in the release branch, the extension version in `package.json` should not have the "-dev" suffix', async function() {
+ if (!branchName!.startsWith('release')) {
+ // tslint:disable-next-line: no-invalid-this
+ return this.skip();
+ }
+
+ return expect(version.endsWith('-dev'), 'When running a pipeline in the release branch, the extension version in package.json should not have the -dev suffix').to.be.false;
+ });
+});