Try to get tests passing

Co-authored by: Marc Jaramillo mnj.webdeveloper@gmail.com
Co-authored by: Musab Guma'a mgsium@github.com

Author: marcnjaramillo

extensions/ql-vscode/src/cli.ts

@@ -1086,7 +1086,7 @@ export class CliVersionConstraint {
   /**
    * CLI version where the `database unbundle` subcommand was introduced.
    */
-  public static CLI_VERSION_WITH_DATABASE_UNBUNDLE = new SemVer('2.6.4');
+  public static CLI_VERSION_WITH_DATABASE_UNBUNDLE = new SemVer('2.6.0');
 
   constructor(private readonly cli: CodeQLCliServer) {
     /**/

extensions/ql-vscode/src/databaseFetcher.ts

@@ -29,11 +29,11 @@ import { tmpDir } from './run-queries';
  * @param storagePath where to store the unzipped database.
  */
 export async function promptImportInternetDatabase(
-  cli: CodeQLCliServer,
   databaseManager: DatabaseManager,
   storagePath: string,
   progress: ProgressCallback,
   token: CancellationToken,
+  cli?: CodeQLCliServer
 ): Promise<DatabaseItem | undefined> {
   const databaseUrl = await window.showInputBox({
     prompt: 'Enter URL of zipfile of database to download',
@@ -45,12 +45,12 @@ export async function promptImportInternetDatabase(
   validateHttpsUrl(databaseUrl);
 
   const item = await databaseArchiveFetcher(
-    cli,
     databaseUrl,
     databaseManager,
     storagePath,
     progress,
-    token
+    token,
+    cli
   );
 
   if (item) {
@@ -70,11 +70,11 @@ export async function promptImportInternetDatabase(
  * @param storagePath where to store the unzipped database.
  */
 export async function promptImportLgtmDatabase(
-  cli: CodeQLCliServer,
   databaseManager: DatabaseManager,
   storagePath: string,
   progress: ProgressCallback,
-  token: CancellationToken
+  token: CancellationToken,
+  cli?: CodeQLCliServer
 ): Promise<DatabaseItem | undefined> {
   progress({
     message: 'Choose project',
@@ -93,12 +93,12 @@ export async function promptImportLgtmDatabase(
     const databaseUrl = await convertToDatabaseUrl(lgtmUrl, progress);
     if (databaseUrl) {
       const item = await databaseArchiveFetcher(
-        cli,
         databaseUrl,
         databaseManager,
         storagePath,
         progress,
-        token
+        token,
+        cli
       );
       if (item) {
         await commands.executeCommand('codeQLDatabases.focus');
@@ -120,21 +120,21 @@ export async function promptImportLgtmDatabase(
  * @param storagePath where to store the unzipped database.
  */
 export async function importArchiveDatabase(
-  cli: CodeQLCliServer,
   databaseUrl: string,
   databaseManager: DatabaseManager,
   storagePath: string,
   progress: ProgressCallback,
   token: CancellationToken,
+  cli?: CodeQLCliServer,
 ): Promise<DatabaseItem | undefined> {
   try {
     const item = await databaseArchiveFetcher(
-      cli,
       databaseUrl,
       databaseManager,
       storagePath,
       progress,
-      token
+      token,
+      cli
     );
     if (item) {
       await commands.executeCommand('codeQLDatabases.focus');
@@ -162,12 +162,12 @@ export async function importArchiveDatabase(
  * @param token cancellation token
  */
 async function databaseArchiveFetcher(
-  cli: CodeQLCliServer,
   databaseUrl: string,
   databaseManager: DatabaseManager,
   storagePath: string,
   progress: ProgressCallback,
-  token: CancellationToken
+  token: CancellationToken,
+  cli?: CodeQLCliServer,
 ): Promise<DatabaseItem> {
   progress({
     message: 'Getting database',
@@ -181,9 +181,9 @@ async function databaseArchiveFetcher(
   const unzipPath = await getStorageFolder(storagePath, databaseUrl);
 
   if (isFile(databaseUrl)) {
-    await readAndUnzip(cli, databaseUrl, unzipPath, progress);
+    await readAndUnzip(databaseUrl, unzipPath, cli, progress);
   } else {
-    await fetchAndUnzip(cli, databaseUrl, unzipPath, progress);
+    await fetchAndUnzip(databaseUrl, unzipPath, cli, progress);
   }
 
   progress({
@@ -255,9 +255,9 @@ function validateHttpsUrl(databaseUrl: string) {
 }
 
 async function readAndUnzip(
-  cli: CodeQLCliServer,
   zipUrl: string,
   unzipPath: string,
+  cli?: CodeQLCliServer,
   progress?: ProgressCallback
 ) {
   // TODO: Providing progress as the file is unzipped is currently blocked
@@ -268,7 +268,7 @@ async function readAndUnzip(
     step: 9,
     message: `Unzipping into ${path.basename(unzipPath)}`
   });
-  if(await cli.cliConstraints.supportsDatabaseUnbundle()) {
+  if (cli !== undefined && await cli.cliConstraints.supportsDatabaseUnbundle()) {
     // Use the `database unbundle` command if the installed cli version supports it
     await cli.databaseUnbundle(zipFile, unzipPath);
   } else {
@@ -281,9 +281,9 @@ async function readAndUnzip(
 }
 
 async function fetchAndUnzip(
-  cli: CodeQLCliServer,
   databaseUrl: string,
   unzipPath: string,
+  cli?: CodeQLCliServer,
   progress?: ProgressCallback
 ) {
   // Although it is possible to download and stream directly to an unzipped directory,
@@ -312,8 +312,9 @@ async function fetchAndUnzip(
       .on('finish', resolve)
       .on('error', reject)
   );
-
-  await readAndUnzip(cli, Uri.file(archivePath).toString(true), unzipPath, progress);
+  if (cli && await cli.cliConstraints.supportsDatabaseUnbundle()) {
+    await readAndUnzip(Uri.file(archivePath).toString(true), unzipPath, cli, progress);
+  }
 
   // remove archivePath eagerly since these archives can be large.
   await fs.remove(archivePath);

extensions/ql-vscode/src/databases-ui.ts

@@ -458,11 +458,11 @@ export class DatabaseUI extends DisposableObject {
       throw new Error('Query server not started');
     }
     return await promptImportInternetDatabase(
-      this.queryServer.cliServer,
       this.databaseManager,
       this.storagePath,
       progress,
-      token
+      token,
+      this.queryServer.cliServer
     );
   };
 
@@ -474,11 +474,11 @@ export class DatabaseUI extends DisposableObject {
       throw new Error('Query server not started');
     }
     return await promptImportLgtmDatabase(
-      this.queryServer.cliServer,
       this.databaseManager,
       this.storagePath,
       progress,
-      token
+      token,
+      this.queryServer.cliServer
     );
   };
 
@@ -588,12 +588,12 @@ export class DatabaseUI extends DisposableObject {
       // Assume user has selected an archive if the file has a .zip extension
       if (uri.path.endsWith('.zip')) {
         await importArchiveDatabase(
-          this.queryServer.cliServer,
           uri.toString(true),
           this.databaseManager,
           this.storagePath,
           progress,
-          token
+          token,
+          this.queryServer.cliServer
         );
       } else {
         await this.setCurrentDatabase(progress, token, uri);
@@ -725,12 +725,12 @@ export class DatabaseUI extends DisposableObject {
       // we are selecting a database archive. Must unzip into a workspace-controlled area
       // before importing.
       return await importArchiveDatabase(
-        this.queryServer.cliServer,
         uri.toString(true),
         this.databaseManager,
         this.storagePath,
         progress,
-        token
+        token,
+        this.queryServer.cliServer
       );
     }
   }

extensions/ql-vscode/src/vscode-tests/cli-integration/databases.test.ts

@@ -19,10 +19,10 @@ describe('Databases', function() {
 
   const LGTM_URL = 'https://lgtm.com/projects/g/aeisenberg/angular-bind-notifier/';
 
-  let cli: CodeQLCliServer;
   let databaseManager: DatabaseManager;
   let sandbox: sinon.SinonSandbox;
   let inputBoxStub: sinon.SinonStub;
+  let cli: CodeQLCliServer;
   let progressCallback: ProgressCallback;
 
   beforeEach(async () => {
@@ -55,7 +55,7 @@ describe('Databases', function() {
   it('should add a database from a folder', async () => {
     const progressCallback = sandbox.spy() as ProgressCallback;
     const uri = Uri.file(dbLoc);
-    let dbItem = await importArchiveDatabase(cli, uri.toString(true), databaseManager, storagePath, progressCallback, {} as CancellationToken);
+    let dbItem = await importArchiveDatabase(uri.toString(true), databaseManager, storagePath, progressCallback, {} as CancellationToken, cli);
     expect(dbItem).to.be.eq(databaseManager.currentDatabaseItem);
     expect(dbItem).to.be.eq(databaseManager.databaseItems[0]);
     expect(dbItem).not.to.be.undefined;
@@ -66,7 +66,7 @@ describe('Databases', function() {
 
   it('should add a database from lgtm with only one language', async () => {
     inputBoxStub.resolves(LGTM_URL);
-    let dbItem = await promptImportLgtmDatabase(cli, databaseManager, storagePath, progressCallback, {} as CancellationToken);
+    let dbItem = await promptImportLgtmDatabase(databaseManager, storagePath, progressCallback, {} as CancellationToken, cli);
     expect(dbItem).not.to.be.undefined;
     dbItem = dbItem!;
     expect(dbItem.name).to.eq('aeisenberg_angular-bind-notifier_106179a');
@@ -76,7 +76,7 @@ describe('Databases', function() {
   it('should add a database from a url', async () => {
     inputBoxStub.resolves(DB_URL);
 
-    let dbItem = await promptImportInternetDatabase(cli, databaseManager, storagePath, progressCallback, {} as CancellationToken);
+    let dbItem = await promptImportInternetDatabase(databaseManager, storagePath, progressCallback, {} as CancellationToken, cli);
     expect(dbItem).not.to.be.undefined;
     dbItem = dbItem!;
     expect(dbItem.name).to.eq('db');