Re-generate package files with new names and add shared test that was missing

Author: jeongsoolee09

cpp/autosar/src/rules/A9-6-2/BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols.ql

@@ -0,0 +1,26 @@
+/**
+ * @id cpp/autosar/bit-fields-should-not-be-declared-autosar-cpp
+ * @name A9-6-2: Bit-fields shall be used only when interfacing to hardware or conforming to communication protocols
+ * @description The usage of bit-fields increases code complexity and certain aspects of bit-field
+ *              manipulation can be error prone and implementation defined. Hence a bit-field usage
+ *              is reserved only when interfacing to hardware or conformance to communication
+ *              protocols.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity recommendation
+ * @tags external/autosar/id/a9-6-2
+ *       maintainability
+ *       external/autosar/allocated-target/design
+ *       external/autosar/enforcement/partially-automated
+ *       external/autosar/obligation/required
+ */
+
+import cpp
+import codingstandards.cpp.autosar
+import codingstandards.cpp.rules.bitfieldsshallbeusedonlywheninterfacingtohardwareorconformingtocommunicationprotocols.BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols
+
+module BitFieldsShouldNotBeDeclaredAutosarCppConfig implements BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocolsConfigSig {
+  Query getQuery() { result = RepresentationPackage::bitFieldsShouldNotBeDeclaredAutosarCppQuery() }
+}
+
+import BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols<BitFieldsShouldNotBeDeclaredAutosarCppConfig>

cpp/autosar/src/rules/A9-6-2/BitFieldsShouldNotBeDeclaredAutosarCpp.ql

@@ -3,24 +3,24 @@ import cpp
 import RuleMetadata
 import codingstandards.cpp.exclusions.RuleMetadata
 
-newtype Banned5Query = TBitFieldsShouldNotBeDeclaredQuery()
+newtype Banned5Query = TBitFieldsShouldNotBeDeclaredMisraCppQuery()
 
 predicate isBanned5QueryMetadata(Query query, string queryId, string ruleId, string category) {
   query =
-    // `Query` instance for the `bitFieldsShouldNotBeDeclared` query
-    Banned5Package::bitFieldsShouldNotBeDeclaredQuery() and
+    // `Query` instance for the `bitFieldsShouldNotBeDeclaredMisraCpp` query
+    Banned5Package::bitFieldsShouldNotBeDeclaredMisraCppQuery() and
   queryId =
-    // `@id` for the `bitFieldsShouldNotBeDeclared` query
-    "cpp/misra/bit-fields-should-not-be-declared" and
+    // `@id` for the `bitFieldsShouldNotBeDeclaredMisraCpp` query
+    "cpp/misra/bit-fields-should-not-be-declared-misra-cpp" and
   ruleId = "RULE-12-2-1" and
   category = "advisory"
 }
 
 module Banned5Package {
-  Query bitFieldsShouldNotBeDeclaredQuery() {
+  Query bitFieldsShouldNotBeDeclaredMisraCppQuery() {
     //autogenerate `Query` type
     result =
-      // `Query` type for `bitFieldsShouldNotBeDeclared` query
-      TQueryCPP(TBanned5PackageQuery(TBitFieldsShouldNotBeDeclaredQuery()))
+      // `Query` type for `bitFieldsShouldNotBeDeclaredMisraCpp` query
+      TQueryCPP(TBanned5PackageQuery(TBitFieldsShouldNotBeDeclaredMisraCppQuery()))
   }
 }

cpp/autosar/test/rules/A9-6-2/BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols.expected

@@ -4,7 +4,7 @@ import RuleMetadata
 import codingstandards.cpp.exclusions.RuleMetadata
 
 newtype RepresentationQuery =
-  TBitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocolsQuery() or
+  TBitFieldsShouldNotBeDeclaredAutosarCppQuery() or
   TAuditPossibleHardwareInterfaceDueToBitFieldUsageInDataTypeDefinitionQuery() or
   TObjectAssignedToAnOverlappingObjectAutosarCppQuery() or
   TDoNotPassAliasedPointerToParamQuery() or
@@ -16,11 +16,11 @@ newtype RepresentationQuery =
 
 predicate isRepresentationQueryMetadata(Query query, string queryId, string ruleId, string category) {
   query =
-    // `Query` instance for the `bitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols` query
-    RepresentationPackage::bitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocolsQuery() and
+    // `Query` instance for the `bitFieldsShouldNotBeDeclaredAutosarCpp` query
+    RepresentationPackage::bitFieldsShouldNotBeDeclaredAutosarCppQuery() and
   queryId =
-    // `@id` for the `bitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols` query
-    "cpp/autosar/bit-fields-shall-be-used-only-when-interfacing-to-hardware-or-conforming-to-communication-protocols" and
+    // `@id` for the `bitFieldsShouldNotBeDeclaredAutosarCpp` query
+    "cpp/autosar/bit-fields-should-not-be-declared-autosar-cpp" and
   ruleId = "A9-6-2" and
   category = "required"
   or
@@ -98,11 +98,11 @@ predicate isRepresentationQueryMetadata(Query query, string queryId, string rule
 }
 
 module RepresentationPackage {
-  Query bitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocolsQuery() {
+  Query bitFieldsShouldNotBeDeclaredAutosarCppQuery() {
     //autogenerate `Query` type
     result =
-      // `Query` type for `bitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols` query
-      TQueryCPP(TRepresentationPackageQuery(TBitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocolsQuery()))
+      // `Query` type for `bitFieldsShouldNotBeDeclaredAutosarCpp` query
+      TQueryCPP(TRepresentationPackageQuery(TBitFieldsShouldNotBeDeclaredAutosarCppQuery()))
   }
 
   Query auditPossibleHardwareInterfaceDueToBitFieldUsageInDataTypeDefinitionQuery() {

cpp/autosar/test/rules/A9-6-2/BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols.qlref

@@ -0,0 +1,59 @@
+typedef int MYINT;
+
+/**
+ * @HardwareOrProtocolInterface
+ */
+class HW_A {};
+
+/**
+ * @HardwareOrProtocolInterface
+ */
+class HW_A1 : HW_A {
+public:
+  int a1;
+  int a2;
+};
+
+/**
+ * @HardwareOrProtocolInterface
+ */
+class HW_A2 : HW_A {
+public:
+  int a1 : 2; // NON_COMPLIANT
+  int a2;
+};
+
+/**
+ * @HardwareOrProtocolInterface
+ */
+class HW_B {};
+
+class B {};
+
+/**
+ * @HardwareOrProtocolInterface
+ */
+class HW_B1 : HW_B {
+public:
+  int a;
+};
+
+/**
+ * @HardwareOrProtocolInterface
+ */
+class HW_B2 : HW_B {
+public:
+  int a1;
+  MYINT a2 : 2; // NON_COMPLIANT
+
+  char b1;
+  char c1 : 2; // NON_COMPLIANT
+};
+
+class B2 : B {
+public:
+  int a;
+  char b;
+  char c : 2; // NON_COMPLIANT
+};
+

…2-1/BitFieldsShouldNotBeDeclared.testref …ldsShouldNotBeDeclaredAutosarCpp.testrefcpp/misra/test/rules/RULE-12-2-1/BitFieldsShouldNotBeDeclared.testref renamed to cpp/autosar/test/rules/A9-6-2/BitFieldsShouldNotBeDeclaredAutosarCpp.testref cpp/misra/test/rules/RULE-12-2-1/BitFieldsShouldNotBeDeclared.testref renamed to cpp/autosar/test/rules/A9-6-2/BitFieldsShouldNotBeDeclaredAutosarCpp.testref

@@ -0,0 +1,24 @@
+/**
+ * @id cpp/misra/bit-fields-should-not-be-declared-misra-cpp
+ * @name RULE-12-2-1: Bit-fields should not be declared
+ * @description The exact layout and the order of bits resulting from bit-fields in a struct is
+ *              implementation-defined and therefore not portable.
+ * @kind problem
+ * @precision very-high
+ * @problem.severity error
+ * @tags external/misra/id/rule-12-2-1
+ *       scope/single-translation-unit
+ *       correctness
+ *       external/misra/enforcement/decidable
+ *       external/misra/obligation/advisory
+ */
+
+import cpp
+import codingstandards.cpp.misra
+import codingstandards.cpp.rules.bitfieldsshallbeusedonlywheninterfacingtohardwareorconformingtocommunicationprotocols.BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols
+
+module BitFieldsShouldNotBeDeclaredMisraCppConfig implements BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocolsConfigSig {
+  Query getQuery() { result = Banned5Package::bitFieldsShouldNotBeDeclaredMisraCppQuery() }
+}
+
+import BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols<BitFieldsShouldNotBeDeclaredMisraCppConfig>

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

@@ -0,0 +1 @@
+cpp/common/test/rules/bitfieldsshallbeusedonlywheninterfacingtohardwareorconformingtocommunicationprotocols/BitFieldsShallBeUsedOnlyWhenInterfacingToHardwareOrConformingToCommunicationProtocols.ql