feat: report errors on unresolved actions (#38)

Fixes $5

Author: OmarTawfik

src/binding/visitors/actions-analyzer.ts

@@ -9,25 +9,26 @@ import { MAXIMUM_SUPPORTED_ACTIONS } from "../../util/constants";
 
 export class ActionsAnalyzer extends BoundNodeVisitor {
   private exceededMaximum = false;
-  private allActions = new Set<string>();
+  private actions = new Set<string>();
 
   private constructor(document: BoundDocument, private readonly bag: DiagnosticBag) {
     super();
     this.visit(document);
   }
 
-  public static analyze(document: BoundDocument, bag: DiagnosticBag): void {
-    new ActionsAnalyzer(document, bag);
+  public static analyze(document: BoundDocument, bag: DiagnosticBag): ReadonlySet<string> {
+    const instance = new ActionsAnalyzer(document, bag);
+    return instance.actions;
   }
 
   protected visitAction(node: BoundAction): void {
-    if (this.allActions.has(node.name)) {
+    if (this.actions.has(node.name)) {
       this.bag.duplicateActions(node.name, node.syntax.name.range);
     } else {
-      this.allActions.add(node.name);
+      this.actions.add(node.name);
     }
 
-    if (!this.exceededMaximum && this.allActions.size > MAXIMUM_SUPPORTED_ACTIONS) {
+    if (!this.exceededMaximum && this.actions.size > MAXIMUM_SUPPORTED_ACTIONS) {
       this.bag.tooManyActions(node.syntax.name.range);
       this.exceededMaximum = true;
     }

src/binding/visitors/resolves-analyzer.ts

@@ -0,0 +1,32 @@
+/*!
+ * Copyright 2019 Omar Tawfik. Please see LICENSE file at the root of this repository.
+ */
+
+import { BoundNodeVisitor } from "../bound-node-visitor";
+import { DiagnosticBag } from "../../util/diagnostics";
+import { BoundDocument, BoundResolves } from "../bound-nodes";
+
+export class ResolvesAnalyzer extends BoundNodeVisitor {
+  private constructor(
+    document: BoundDocument,
+    private readonly actions: ReadonlySet<string>,
+    private readonly bag: DiagnosticBag,
+  ) {
+    super();
+    this.visit(document);
+  }
+
+  public static analyze(document: BoundDocument, actions: ReadonlySet<string>, bag: DiagnosticBag): void {
+    new ResolvesAnalyzer(document, actions, bag);
+  }
+
+  protected visitResolves(node: BoundResolves): void {
+    for (const action of node.actions) {
+      if (!this.actions.has(action.value)) {
+        this.bag.actionDoesNotExist(action.value, action.syntax.range);
+      }
+    }
+
+    super.visitResolves(node);
+  }
+}

src/binding/visitors/secrets-analyzer.ts

@@ -9,7 +9,7 @@ import { MAXIMUM_SUPPORTED_SECRETS } from "../../util/constants";
 
 export class SecretsAnalyzer extends BoundNodeVisitor {
   private exceededMaximum = false;
-  private allSecrets = new Set<string>();
+  private secrets = new Set<string>();
 
   private constructor(document: BoundDocument, private readonly bag: DiagnosticBag) {
     super();
@@ -32,8 +32,8 @@ export class SecretsAnalyzer extends BoundNodeVisitor {
 
     if (!this.exceededMaximum) {
       for (const secret of node.secrets) {
-        this.allSecrets.add(secret.value);
-        if (this.allSecrets.size > MAXIMUM_SUPPORTED_SECRETS) {
+        this.secrets.add(secret.value);
+        if (this.secrets.size > MAXIMUM_SUPPORTED_SECRETS) {
           this.bag.tooManySecrets(secret.syntax.range);
           this.exceededMaximum = true;
           break;

src/util/compilation.ts

@@ -11,6 +11,7 @@ import { BoundDocument } from "../binding/bound-nodes";
 import { bindDocument } from "../binding/binder";
 import { SecretsAnalyzer } from "../binding/visitors/secrets-analyzer";
 import { ActionsAnalyzer } from "../binding/visitors/actions-analyzer";
+import { ResolvesAnalyzer } from "../binding/visitors/resolves-analyzer";
 
 export class Compilation {
   private readonly bag: DiagnosticBag;
@@ -24,7 +25,8 @@ export class Compilation {
     this.syntax = parseTokens(this.tokens, this.bag);
     this.document = bindDocument(this.syntax, this.bag);
 
-    ActionsAnalyzer.analyze(this.document, this.bag);
+    const actions = ActionsAnalyzer.analyze(this.document, this.bag);
+    ResolvesAnalyzer.analyze(this.document, actions, this.bag);
     SecretsAnalyzer.analyze(this.document, this.bag);
   }
 

src/util/diagnostics.ts

@@ -33,6 +33,7 @@ export enum DiagnosticCode {
   DuplicateSecrets,
   TooManyActions,
   DuplicateActions,
+  ActionDoesNotExist,
 }
 
 export interface Diagnostic {
@@ -215,4 +216,12 @@ export class DiagnosticBag {
       message: `This file already defines another action with the name '${duplicate}'.`,
     });
   }
+
+  public actionDoesNotExist(action: string, range: TextRange): void {
+    this.items.push({
+      range,
+      code: DiagnosticCode.ActionDoesNotExist,
+      message: `The action '${action}' does not exist in the same workflow file.`,
+    });
+  }
 }

test/analysis-errors.spec.ts

@@ -219,6 +219,35 @@ ERROR: Too many actions defined. The maximum currently supported is '100'.
     |        ^^^^^^^^^^^
 103 | 
 "
+`);
+  });
+
+  it("reports error on resolving a non-existing action", () => {
+    expectDiagnostics(`
+action "a" {
+    uses = "./ci"
+}
+action "b" {
+    uses = "./ci"
+}
+workflow "c" {
+    on = "fork"
+    resolves = [
+      "a",
+      "b",
+      "not_found"
+    ]
+}
+`).toMatchInlineSnapshot(`
+"
+ERROR: The action 'not_found' does not exist in the same workflow file.
+ 11 |       \\"a\\",
+ 12 |       \\"b\\",
+ 13 |       \\"not_found\\"
+    |       ^^^^^^^^^^^
+ 14 |     ]
+ 15 | }
+"
 `);
   });
 });

test/parsing-errors.spec.ts

@@ -89,28 +89,34 @@ ERROR: A token of kind 'string' or '{' or '[' was expected here.
 
   it("reports errors on extra commas in a string array", () => {
     expectDiagnostics(`
+action "a" {
+    uses = "./ci"
+}
+action "b" {
+    uses = "./ci"
+}
 workflow "x" {
-  on = "fork"
-  resolves = [
-    "a", "b", , , "c", 
-  ]
+    on = "fork"
+    resolves = [
+        , "a", , "b", 
+    ]
 }
 `).toMatchInlineSnapshot(`
 "
 ERROR: A token of kind ',' was not expected here.
-  3 |   on = \\"fork\\"
-  4 |   resolves = [
-  5 |     \\"a\\", \\"b\\", , , \\"c\\", 
-    |               ^
-  6 |   ]
-  7 | }
+  9 |     on = \\"fork\\"
+ 10 |     resolves = [
+ 11 |         , \\"a\\", , \\"b\\", 
+    |         ^
+ 12 |     ]
+ 13 | }
 ERROR: A token of kind ',' was not expected here.
-  3 |   on = \\"fork\\"
-  4 |   resolves = [
-  5 |     \\"a\\", \\"b\\", , , \\"c\\", 
-    |                 ^
-  6 |   ]
-  7 | }
+  9 |     on = \\"fork\\"
+ 10 |     resolves = [
+ 11 |         , \\"a\\", , \\"b\\", 
+    |                ^
+ 12 |     ]
+ 13 | }
 "
 `);
   });