Merge pull request #54 from returntocorp/brandon/label-pro-matches

brandonspark · web-flow · commit b0960d209859 · 2023-01-25T16:10:51.000-08:00
chore: label pro matches with engine kind
diff --git a/semgrep_output_v1.atd b/semgrep_output_v1.atd
@@ -102,6 +102,13 @@ type rule_id
 (*****************************************************************************)
 (* EXPERIMENTAL: Do not rely on those internal types, they might disappear *)
 
+type engine_kind
+  <ocaml attr="deriving show">
+  <python decorator="dataclass(frozen=True)"> = [
+  | OSSMatch
+  | ProMatch
+] 
+
 type core_match
   <ocaml attr="deriving show">
   <python decorator="dataclass(frozen=True)"> = {
@@ -120,6 +127,8 @@ type core_match_extra
    * inserted in place of the text in the matched range in order to fix the
    * finding. *)
   ?rendered_fix: string option;
+
+  engine_kind: engine_kind;
 }
 
 type core_match_call_trace
@@ -590,6 +599,8 @@ type cli_match_extra <ocaml attr="deriving show"> = {
   (* EXPERIMENTAL: For now, present only for taint findings. May be extended to others
    * later on. *)
   ?dataflow_trace: cli_match_dataflow_trace option;
+
+  engine_kind: engine_kind;
 }
 
 type fix_regex <ocaml attr="deriving show"> = {
diff --git a/semgrep_output_v1.jsonschema b/semgrep_output_v1.jsonschema
@@ -43,6 +43,9 @@
       }
     },
     "rule_id": { "type": "string" },
+    "engine_kind": {
+      "oneOf": [ { "const": "OSSMatch" }, { "const": "ProMatch" } ]
+    },
     "core_match": {
       "type": "object",
       "required": [ "rule_id", "location", "extra" ],
@@ -54,14 +57,15 @@
     },
     "core_match_extra": {
       "type": "object",
-      "required": [ "metavars" ],
+      "required": [ "metavars", "engine_kind" ],
       "properties": {
         "message": { "type": "string" },
         "metavars": { "$ref": "#/definitions/metavars" },
         "dataflow_trace": {
           "$ref": "#/definitions/core_match_dataflow_trace"
         },
-        "rendered_fix": { "type": "string" }
+        "rendered_fix": { "type": "string" },
+        "engine_kind": { "$ref": "#/definitions/engine_kind" }
       }
     },
     "core_match_call_trace": {
@@ -491,7 +495,8 @@
     "cli_match_extra": {
       "type": "object",
       "required": [
-        "fingerprint", "lines", "message", "metadata", "severity"
+        "fingerprint", "lines", "message", "metadata", "severity",
+        "engine_kind"
       ],
       "properties": {
         "metavars": { "$ref": "#/definitions/metavars" },
@@ -507,7 +512,8 @@
         "fixed_lines": { "type": "array", "items": { "type": "string" } },
         "dataflow_trace": {
           "$ref": "#/definitions/cli_match_dataflow_trace"
-        }
+        },
+        "engine_kind": { "$ref": "#/definitions/engine_kind" }
       }
     },
     "fix_regex": {
diff --git a/semgrep_output_v1.py b/semgrep_output_v1.py
@@ -237,6 +237,72 @@ def write_nullable(x: Any) -> Any:
 ############################################################################
 
 
+@dataclass(frozen=True)
+class OSSMatch:
+    """Original type: engine_kind = [ ... | OSSMatch | ... ]"""
+
+    @property
+    def kind(self) -> str:
+        """Name of the class representing this variant."""
+        return 'OSSMatch'
+
+    @staticmethod
+    def to_json() -> Any:
+        return 'OSSMatch'
+
+    def to_json_string(self, **kw: Any) -> str:
+        return json.dumps(self.to_json(), **kw)
+
+
+@dataclass(frozen=True)
+class ProMatch:
+    """Original type: engine_kind = [ ... | ProMatch | ... ]"""
+
+    @property
+    def kind(self) -> str:
+        """Name of the class representing this variant."""
+        return 'ProMatch'
+
+    @staticmethod
+    def to_json() -> Any:
+        return 'ProMatch'
+
+    def to_json_string(self, **kw: Any) -> str:
+        return json.dumps(self.to_json(), **kw)
+
+
+@dataclass(frozen=True)
+class EngineKind:
+    """Original type: engine_kind = [ ... ]"""
+
+    value: Union[OSSMatch, ProMatch]
+
+    @property
+    def kind(self) -> str:
+        """Name of the class representing this variant."""
+        return self.value.kind
+
+    @classmethod
+    def from_json(cls, x: Any) -> 'EngineKind':
+        if isinstance(x, str):
+            if x == 'OSSMatch':
+                return cls(OSSMatch())
+            if x == 'ProMatch':
+                return cls(ProMatch())
+            _atd_bad_json('EngineKind', x)
+        _atd_bad_json('EngineKind', x)
+
+    def to_json(self) -> Any:
+        return self.value.to_json()
+
+    @classmethod
+    def from_json_string(cls, x: str) -> 'EngineKind':
+        return cls.from_json(json.loads(x))
+
+    def to_json_string(self, **kw: Any) -> str:
+        return json.dumps(self.to_json(), **kw)
+
+
 @dataclass(frozen=True)
 class And:
     """Original type: matching_operation = [ ... | And | ... ]"""
@@ -852,6 +918,7 @@ class CoreMatchExtra:
     """Original type: core_match_extra = { ... }"""
 
     metavars: Metavars
+    engine_kind: EngineKind
     message: Optional[str] = None
     dataflow_trace: Optional[CoreMatchDataflowTrace] = None
     rendered_fix: Optional[str] = None
@@ -861,6 +928,7 @@ def from_json(cls, x: Any) -> 'CoreMatchExtra':
         if isinstance(x, dict):
             return cls(
                 metavars=Metavars.from_json(x['metavars']) if 'metavars' in x else _atd_missing_json_field('CoreMatchExtra', 'metavars'),
+                engine_kind=EngineKind.from_json(x['engine_kind']) if 'engine_kind' in x else _atd_missing_json_field('CoreMatchExtra', 'engine_kind'),
                 message=_atd_read_string(x['message']) if 'message' in x else None,
                 dataflow_trace=CoreMatchDataflowTrace.from_json(x['dataflow_trace']) if 'dataflow_trace' in x else None,
                 rendered_fix=_atd_read_string(x['rendered_fix']) if 'rendered_fix' in x else None,
@@ -871,6 +939,7 @@ def from_json(cls, x: Any) -> 'CoreMatchExtra':
     def to_json(self) -> Any:
         res: Dict[str, Any] = {}
         res['metavars'] = (lambda x: x.to_json())(self.metavars)
+        res['engine_kind'] = (lambda x: x.to_json())(self.engine_kind)
         if self.message is not None:
             res['message'] = _atd_write_string(self.message)
         if self.dataflow_trace is not None:
@@ -2837,6 +2906,7 @@ class CliMatchExtra:
     message: str
     metadata: RawJson
     severity: str
+    engine_kind: EngineKind
     metavars: Optional[Metavars] = None
     fix: Optional[str] = None
     fix_regex: Optional[FixRegex] = None
@@ -2854,6 +2924,7 @@ def from_json(cls, x: Any) -> 'CliMatchExtra':
                 message=_atd_read_string(x['message']) if 'message' in x else _atd_missing_json_field('CliMatchExtra', 'message'),
                 metadata=RawJson.from_json(x['metadata']) if 'metadata' in x else _atd_missing_json_field('CliMatchExtra', 'metadata'),
                 severity=_atd_read_string(x['severity']) if 'severity' in x else _atd_missing_json_field('CliMatchExtra', 'severity'),
+                engine_kind=EngineKind.from_json(x['engine_kind']) if 'engine_kind' in x else _atd_missing_json_field('CliMatchExtra', 'engine_kind'),
                 metavars=Metavars.from_json(x['metavars']) if 'metavars' in x else None,
                 fix=_atd_read_string(x['fix']) if 'fix' in x else None,
                 fix_regex=FixRegex.from_json(x['fix_regex']) if 'fix_regex' in x else None,
@@ -2872,6 +2943,7 @@ def to_json(self) -> Any:
         res['message'] = _atd_write_string(self.message)
         res['metadata'] = (lambda x: x.to_json())(self.metadata)
         res['severity'] = _atd_write_string(self.severity)
+        res['engine_kind'] = (lambda x: x.to_json())(self.engine_kind)
         if self.metavars is not None:
             res['metavars'] = (lambda x: x.to_json())(self.metavars)
         if self.fix is not None:
diff --git a/semgrep_output_v1.ts b/semgrep_output_v1.ts
@@ -30,6 +30,10 @@ export type Location = {
 
 export type RuleId = string
 
+export type EngineKind =
+| { kind: 'OSSMatch' }
+| { kind: 'ProMatch' }
+
 export type CoreMatch = {
   rule_id: RuleId;
   location: Location;
@@ -41,6 +45,7 @@ export type CoreMatchExtra = {
   metavars: Metavars;
   dataflow_trace?: CoreMatchDataflowTrace;
   rendered_fix?: string;
+  engine_kind: EngineKind;
 }
 
 export type CoreMatchCallTrace =
@@ -259,6 +264,7 @@ export type CliMatchExtra = {
   sca_info?: ScaInfo;
   fixed_lines?: string[];
   dataflow_trace?: CliMatchDataflowTrace;
+  engine_kind: EngineKind;
 }
 
 export type FixRegex = {
@@ -441,6 +447,27 @@ export function readRuleId(x: any, context: any = x): RuleId {
   return _atd_read_string(x, context);
 }
 
+export function writeEngineKind(x: EngineKind, context: any = x): any {
+  switch (x.kind) {
+    case 'OSSMatch':
+      return 'OSSMatch'
+    case 'ProMatch':
+      return 'ProMatch'
+  }
+}
+
+export function readEngineKind(x: any, context: any = x): EngineKind {
+  switch (x) {
+    case 'OSSMatch':
+      return { kind: 'OSSMatch' }
+    case 'ProMatch':
+      return { kind: 'ProMatch' }
+    default:
+      _atd_bad_json('EngineKind', x, context)
+      throw new Error('impossible')
+  }
+}
+
 export function writeCoreMatch(x: CoreMatch, context: any = x): any {
   return {
     'rule_id': _atd_write_required_field('CoreMatch', 'rule_id', writeRuleId, x.rule_id, x),
@@ -463,6 +490,7 @@ export function writeCoreMatchExtra(x: CoreMatchExtra, context: any = x): any {
     'metavars': _atd_write_required_field('CoreMatchExtra', 'metavars', writeMetavars, x.metavars, x),
     'dataflow_trace': _atd_write_optional_field(writeCoreMatchDataflowTrace, x.dataflow_trace, x),
     'rendered_fix': _atd_write_optional_field(_atd_write_string, x.rendered_fix, x),
+    'engine_kind': _atd_write_required_field('CoreMatchExtra', 'engine_kind', writeEngineKind, x.engine_kind, x),
   };
 }
 
@@ -472,6 +500,7 @@ export function readCoreMatchExtra(x: any, context: any = x): CoreMatchExtra {
     metavars: _atd_read_required_field('CoreMatchExtra', 'metavars', readMetavars, x['metavars'], x),
     dataflow_trace: _atd_read_optional_field(readCoreMatchDataflowTrace, x['dataflow_trace'], x),
     rendered_fix: _atd_read_optional_field(_atd_read_string, x['rendered_fix'], x),
+    engine_kind: _atd_read_required_field('CoreMatchExtra', 'engine_kind', readEngineKind, x['engine_kind'], x),
   };
 }
 
@@ -1145,6 +1174,7 @@ export function writeCliMatchExtra(x: CliMatchExtra, context: any = x): any {
     'sca_info': _atd_write_optional_field(writeScaInfo, x.sca_info, x),
     'fixed_lines': _atd_write_optional_field(_atd_write_array(_atd_write_string), x.fixed_lines, x),
     'dataflow_trace': _atd_write_optional_field(writeCliMatchDataflowTrace, x.dataflow_trace, x),
+    'engine_kind': _atd_write_required_field('CliMatchExtra', 'engine_kind', writeEngineKind, x.engine_kind, x),
   };
 }
 
@@ -1162,6 +1192,7 @@ export function readCliMatchExtra(x: any, context: any = x): CliMatchExtra {
     sca_info: _atd_read_optional_field(readScaInfo, x['sca_info'], x),
     fixed_lines: _atd_read_optional_field(_atd_read_array(_atd_read_string), x['fixed_lines'], x),
     dataflow_trace: _atd_read_optional_field(readCliMatchDataflowTrace, x['dataflow_trace'], x),
+    engine_kind: _atd_read_required_field('CliMatchExtra', 'engine_kind', readEngineKind, x['engine_kind'], x),
   };
 }
 
diff --git a/semgrep_output_v1_j.ml b/semgrep_output_v1_j.ml
diff --git a/semgrep_output_v1_j.mli b/semgrep_output_v1_j.mli
