Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "actions" as an analysis language #3961

Merged
merged 1 commit into from
Apr 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion extensions/ql-vscode/src/common/query-language.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
export enum QueryLanguage {
Actions = "actions",
CSharp = "csharp",
Cpp = "cpp",
Go = "go",
Expand All @@ -11,6 +12,8 @@ export enum QueryLanguage {

export function getLanguageDisplayName(language: string): string {
switch (language) {
case QueryLanguage.Actions:
return "Actions";
case QueryLanguage.CSharp:
return "C#";
case QueryLanguage.Cpp:
Expand All @@ -33,6 +36,7 @@ export function getLanguageDisplayName(language: string): string {
}

export const PACKS_BY_QUERY_LANGUAGE = {
[QueryLanguage.Actions]: ["codeql/actions-queries"],
[QueryLanguage.Cpp]: ["codeql/cpp-queries"],
[QueryLanguage.CSharp]: [
"codeql/csharp-queries",
Expand All @@ -46,7 +50,7 @@ export const PACKS_BY_QUERY_LANGUAGE = {
};

export const dbSchemeToLanguage: Record<string, QueryLanguage> = {
"semmlecode.javascript.dbscheme": QueryLanguage.Javascript,
"semmlecode.javascript.dbscheme": QueryLanguage.Javascript, // This can also be QueryLanguage.Actions
"semmlecode.cpp.dbscheme": QueryLanguage.Cpp,
"semmlecode.dbscheme": QueryLanguage.Java,
"semmlecode.python.dbscheme": QueryLanguage.Python,
Expand All @@ -56,6 +60,18 @@ export const dbSchemeToLanguage: Record<string, QueryLanguage> = {
"swift.dbscheme": QueryLanguage.Swift,
};

export const languageToDbScheme = Object.entries(dbSchemeToLanguage).reduce(
(acc, [k, v]) => {
acc[v] = k;
return acc;
},
{} as { [k: string]: string },
);

// Actions dbscheme is the same as Javascript dbscheme
languageToDbScheme[QueryLanguage.Actions] =
languageToDbScheme[QueryLanguage.Javascript];

export function isQueryLanguage(language: string): language is QueryLanguage {
return Object.values(QueryLanguage).includes(language as QueryLanguage);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {

const ALL_LANGUAGE_SELECTION_OPTIONS = [
undefined, // All languages
QueryLanguage.Actions,
QueryLanguage.Cpp,
QueryLanguage.CSharp,
QueryLanguage.Go,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export type QueryHistoryItemDto =
| QueryHistoryVariantAnalysisDto;

export enum QueryLanguageDto {
Actions = "actions",
CSharp = "csharp",
Cpp = "cpp",
Go = "go",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ export function mapQueryLanguageToDto(
language: QueryLanguage,
): QueryLanguageDto {
switch (language) {
case QueryLanguage.Actions:
return QueryLanguageDto.Actions;
case QueryLanguage.CSharp:
return QueryLanguageDto.CSharp;
case QueryLanguage.Cpp:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ export function mapQueryLanguageToDomainModel(
language: QueryLanguageDto,
): QueryLanguage {
switch (language) {
case QueryLanguageDto.Actions:
return QueryLanguage.Actions;
case QueryLanguageDto.CSharp:
return QueryLanguage.CSharp;
case QueryLanguageDto.Cpp:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ describe("SkeletonQueryWizard", () => {
getSupportedLanguages: jest
.fn()
.mockResolvedValue([
"actions",
"ruby",
"javascript",
"go",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import { faker } from "@faker-js/faker";
import { getActivatedExtension } from "../global.helper";
import type { BaseLogger } from "../../../src/common/logging";
import { getQlPackForDbscheme } from "../../../src/databases/qlpack";
import { dbSchemeToLanguage } from "../../../src/common/query-language";
import { languageToDbScheme } from "../../../src/common/query-language";

/**
* Perform proper integration tests by running the CLI
Expand All @@ -27,14 +27,6 @@ describe("Use cli", () => {

let logSpy: jest.SpiedFunction<BaseLogger["log"]>;

const languageToDbScheme = Object.entries(dbSchemeToLanguage).reduce(
(acc, [k, v]) => {
acc[v] = k;
return acc;
},
{} as { [k: string]: string },
);

beforeEach(async () => {
const extension = await getActivatedExtension();
cli = extension.cliServer;
Expand Down Expand Up @@ -107,12 +99,17 @@ describe("Use cli", () => {
itWithCodeQL()(
"should resolve printAST queries for supported languages",
async () => {
for (const lang of supportedLanguages) {
for (let lang of supportedLanguages) {
if (lang === "go") {
// The codeql-go submodule is not available in the integration tests.
return;
}

if (lang === "actions") {
// The actions queries use the javascript dbscheme.
lang = "javascript";
}

console.log(`resolving printAST queries for ${lang}`);
const pack = await getQlPackForDbscheme(cli, languageToDbScheme[lang]);
expect(pack.dbschemePack).toContain(lang);
Expand Down
Loading