Fill in shared query file for BannedSyntax and Banned6

Author: jeongsoolee09

cpp/autosar/src/rules/A9-5-1/UnionKeywordUsedAutosarCpp.ql

@@ -0,0 +1,25 @@
+/**
+ * @id cpp/autosar/union-keyword-used-autosar-cpp
+ * @name A9-5-1: Unions shall not be used
+ * @description Unions shall not be used. Tagged unions can be used if 'std::variant' is not
+ *              available.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity error
+ * @tags external/autosar/id/a9-5-1
+ *       correctness
+ *       scope/single-translation-unit
+ *       external/autosar/allocated-target/implementation
+ *       external/autosar/enforcement/automated
+ *       external/autosar/obligation/required
+ */
+
+import cpp
+import codingstandards.cpp.autosar
+import codingstandards.cpp.rules.unionkeywordused.UnionKeywordUsed
+
+module UnionKeywordUsedAutosarCppConfig implements UnionKeywordUsedConfigSig {
+  Query getQuery() { result = BannedSyntaxPackage::unionKeywordUsedAutosarCppQuery() }
+}
+
+import UnionKeywordUsed<UnionKeywordUsedAutosarCppConfig>

cpp/autosar/src/rules/A9-5-1/UnionsUsed.ql

@@ -0,0 +1 @@
+cpp/common/test/rules/unionkeywordused/UnionKeywordUsed.ql

cpp/autosar/test/rules/A9-5-1/UnionKeywordUsedAutosarCpp.testref

@@ -3,24 +3,24 @@ import cpp
 import RuleMetadata
 import codingstandards.cpp.exclusions.RuleMetadata
 
-newtype Banned6Query = TUnionKeywordUsedQuery()
+newtype Banned6Query = TUnionKeywordUsedMisraCppQuery()
 
 predicate isBanned6QueryMetadata(Query query, string queryId, string ruleId, string category) {
   query =
-    // `Query` instance for the `unionKeywordUsed` query
-    Banned6Package::unionKeywordUsedQuery() and
+    // `Query` instance for the `unionKeywordUsedMisraCpp` query
+    Banned6Package::unionKeywordUsedMisraCppQuery() and
   queryId =
-    // `@id` for the `unionKeywordUsed` query
-    "cpp/misra/union-keyword-used" and
+    // `@id` for the `unionKeywordUsedMisraCpp` query
+    "cpp/misra/union-keyword-used-misra-cpp" and
   ruleId = "RULE-12-3-1" and
   category = "required"
 }
 
 module Banned6Package {
-  Query unionKeywordUsedQuery() {
+  Query unionKeywordUsedMisraCppQuery() {
     //autogenerate `Query` type
     result =
-      // `Query` type for `unionKeywordUsed` query
-      TQueryCPP(TBanned6PackageQuery(TUnionKeywordUsedQuery()))
+      // `Query` type for `unionKeywordUsedMisraCpp` query
+      TQueryCPP(TBanned6PackageQuery(TUnionKeywordUsedMisraCppQuery()))
   }
 }

cpp/common/src/codingstandards/cpp/exclusions/cpp/Banned6.qll

@@ -16,7 +16,7 @@ newtype BannedSyntaxQuery =
   TTypedefSpecifierUsedQuery() or
   TAsmDeclarationUsedQuery() or
   TFunctionsDefinedUsingTheEllipsisNotationQuery() or
-  TUnionsUsedQuery() or
+  TUnionKeywordUsedAutosarCppQuery() or
   TCommaOperatorUsedQuery() or
   TUsingDirectivesUsedQuery() or
   TUsingDeclarationsUsedInHeaderFilesQuery() or
@@ -132,11 +132,11 @@ predicate isBannedSyntaxQueryMetadata(Query query, string queryId, string ruleId
   category = "required"
   or
   query =
-    // `Query` instance for the `unionsUsed` query
-    BannedSyntaxPackage::unionsUsedQuery() and
+    // `Query` instance for the `unionKeywordUsedAutosarCpp` query
+    BannedSyntaxPackage::unionKeywordUsedAutosarCppQuery() and
   queryId =
-    // `@id` for the `unionsUsed` query
-    "cpp/autosar/unions-used" and
+    // `@id` for the `unionKeywordUsedAutosarCpp` query
+    "cpp/autosar/union-keyword-used-autosar-cpp" and
   ruleId = "A9-5-1" and
   category = "required"
   or
@@ -262,11 +262,11 @@ module BannedSyntaxPackage {
       TQueryCPP(TBannedSyntaxPackageQuery(TFunctionsDefinedUsingTheEllipsisNotationQuery()))
   }
 
-  Query unionsUsedQuery() {
+  Query unionKeywordUsedAutosarCppQuery() {
     //autogenerate `Query` type
     result =
-      // `Query` type for `unionsUsed` query
-      TQueryCPP(TBannedSyntaxPackageQuery(TUnionsUsedQuery()))
+      // `Query` type for `unionKeywordUsedAutosarCpp` query
+      TQueryCPP(TBannedSyntaxPackageQuery(TUnionKeywordUsedAutosarCppQuery()))
   }
 
   Query commaOperatorUsedQuery() {

cpp/common/src/codingstandards/cpp/exclusions/cpp/BannedSyntax.qll

@@ -13,8 +13,27 @@ signature module UnionKeywordUsedConfigSig {
   Query getQuery();
 }
 
+// A tagged union is a class or a struct
+// that has exactly one union and exactly one enum with
+// corresponding member variable that represents
+// the data type in the union
+class TaggedUnion extends UserType {
+  TaggedUnion() {
+    (this instanceof Class or this instanceof Struct) and
+    count(Enum e | e.getParentScope() = this) = 1 and
+    count(Union u | u.getParentScope() = this) = 1 and
+    count(MemberVariable m, Enum e |
+      m.getDeclaringType() = this and
+      e.getDeclaringType() = this and
+      m.getType().getName() = e.getName()
+    ) = 1
+  }
+}
+
 module UnionKeywordUsed<UnionKeywordUsedConfigSig Config> {
-  query predicate problems(Element e, string message) {
-    not isExcluded(e, Config::getQuery()) and message = "<replace with problem alert message for >"
+  query predicate problems(Union u, string message) {
+    not isExcluded(u, Config::getQuery()) and
+    not u.getParentScope() instanceof TaggedUnion and
+    message = u.getName() + " is not a tagged union."
   }
 }

cpp/common/src/codingstandards/cpp/rules/unionkeywordused/UnionKeywordUsed.qll

@@ -1 +1,2 @@
-No expected results have yet been specified
+| test.cpp:14:9:14:9 | u | u is not a tagged union. |
+| test.cpp:21:7:21:7 | u | u is not a tagged union. |

cpp/common/test/rules/unionkeywordused/UnionKeywordUsed.expected

@@ -0,0 +1,30 @@
+
+struct union_with_tag {
+  enum class TYPE { integer, floating };
+
+  union u { // COMPLIANT - union with tag
+    int i;
+    float f;
+  };
+
+  TYPE tag;
+};
+
+struct union_sans_tag {
+  union u { // NON_COMPLIANT
+    int i;
+    float f;
+  };
+  int x;
+};
+
+union u { // NON_COMPLIANT
+  int i;
+  float f;
+};
+
+void test_unions() {
+  union_with_tag u1;
+  union_sans_tag u2;
+  u u3;
+}

cpp/common/test/rules/unionkeywordused/test.cpp

@@ -0,0 +1,24 @@
+/**
+ * @id cpp/misra/union-keyword-used-misra-cpp
+ * @name RULE-12-3-1: The union keyword shall not be used
+ * @description Using unions should be avoided and 'std::variant' should be used as a type-safe
+ *              alternative.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity error
+ * @tags external/misra/id/rule-12-3-1
+ *       scope/single-translation-unit
+ *       correctness
+ *       external/misra/enforcement/decidable
+ *       external/misra/obligation/required
+ */
+
+import cpp
+import codingstandards.cpp.misra
+import codingstandards.cpp.rules.unionkeywordused.UnionKeywordUsed
+
+module UnionKeywordUsedMisraCppConfig implements UnionKeywordUsedConfigSig {
+  Query getQuery() { result = Banned6Package::unionKeywordUsedMisraCppQuery() }
+}
+
+import UnionKeywordUsed<UnionKeywordUsedMisraCppConfig>

cpp/misra/src/rules/RULE-12-3-1/UnionKeywordUsedMisraCpp.ql

@@ -0,0 +1 @@
+cpp/common/test/rules/unionkeywordused/UnionKeywordUsed.ql