Merge pull request #186 from eclipse-impl/swp-260766

Refactorings needed for injection support

Author: 4og

score/hash/BUILD

@@ -24,7 +24,7 @@ cc_library(
     name = "hash",
     features = COMPILER_WARNING_FEATURES,
     visibility = [
-        "//visibility:public",  # platform_only
+        "//visibility:public",
     ],
     deps = [
         "@score_baselibs//score/hash/code/core/factory/impl:crc_variant",
@@ -35,7 +35,7 @@ cc_library(
     name = "safe_hash",
     features = COMPILER_WARNING_FEATURES,
     tags = ["FFI"],
-    visibility = ["//visibility:public"],  # platform_only
+    visibility = ["//visibility:public"],
     deps = [
         "@score_baselibs//score/hash/code/core/factory/impl:safe_crc_variant",
     ],
@@ -45,7 +45,7 @@ cc_library(
     name = "hash_mock",
     testonly = True,
     features = COMPILER_WARNING_FEATURES,
-    visibility = ["//visibility:public"],  # platform_only
+    visibility = ["//visibility:public"],
     deps = [
         "@score_baselibs//score/hash/code/core:hash_cal_mock",
         "@score_baselibs//score/hash/code/core/factory:factory_mock",
@@ -60,5 +60,5 @@ cc_unit_test_suites_for_host_and_qnx(
         "@score_baselibs//score/hash/code/crc:unit_tests",
         "@score_baselibs//score/hash/code/openssl:unit_tests",
     ],
-    visibility = ["//visibility:public"],  # platform_only
+    visibility = ["//visibility:public"],
 )

score/hash/code/common/BUILD

@@ -78,5 +78,5 @@ cc_test(
 cc_unit_test_suites_for_host_and_qnx(
     name = "unit_tests",
     cc_unit_tests = [":unit_test"],
-    visibility = ["//visibility:public"],  # platform_only
+    visibility = ["//visibility:public"],
 )

score/hash/code/common/algorithms.cpp

@@ -27,8 +27,8 @@ score::cpp::optional<std::uint8_t> HashSizeInBytes(const HashAlgorithm algorithm
         case HashAlgorithm::kCrc32:
             hashSizeInBytes = kCrc32Size;
             break;
-        case HashAlgorithm::kCrc32Unused:
-            hashSizeInBytes = kCrc32UnusedSize;
+        case HashAlgorithm::kCrc32Autosar:
+            hashSizeInBytes = kCrc32AutosarSize;
             break;
         case HashAlgorithm::kSha1:
             hashSizeInBytes = kSha1Size;
@@ -71,7 +71,7 @@ HashAlgorithm IdentifyHash(std::string_view hash_string) noexcept
     switch (hash_string.length())
     {
         case kCrc32Size * 2U:
-            // there's no way to distinguish between kCrc32 and kCrc32Unused based on the bytes alone
+            // there's no way to distinguish between kCrc32 and kCrc32Autosar based on the bytes alone
             identifiedHash = HashAlgorithm::kCrc32;
             break;
         case kSha1Size * 2U:
@@ -100,7 +100,7 @@ HashAlgorithm IdentifyHash(std::size_t hash_size_in_bytes) noexcept
     switch (hash_size_in_bytes)
     {
         case kCrc32Size:
-            // there's no way to distinguish between kCrc32 and kCrc32Unused based on the bytes alone
+            // there's no way to distinguish between kCrc32 and kCrc32Autosar based on the bytes alone
             identifiedHash = HashAlgorithm::kCrc32;
             break;
         case kSha1Size:

score/hash/code/common/algorithms.h

@@ -36,7 +36,7 @@ constexpr std::uint8_t kSha256Size{32U};
 constexpr std::uint8_t kSha384Size{48U};
 constexpr std::uint8_t kSha512Size{64U};
 constexpr std::uint8_t kCrc32Size{4U};
-constexpr std::uint8_t kCrc32UnusedSize{4U};
+constexpr std::uint8_t kCrc32AutosarSize{4U};
 
 /// Cryptographic hash algorithm
 /* KW_SUPPRESS_START:UNUSED.STYLE.SINGLE_STMT_PER_LINE:this is a declaration of an enum; putting this on a single */
@@ -49,7 +49,7 @@ enum class HashAlgorithm : std::uint8_t
     kSha384,
     kSha512,
     kCrc32,
-    kCrc32Unused,
+    kCrc32Autosar,
     kLast
 };
 
@@ -67,8 +67,8 @@ inline score::mw::log::LogStream& operator<<(score::mw::log::LogStream& stream,
         case HashAlgorithm::kCrc32:
             modifiedStream << "Crc32";
             break;
-        case HashAlgorithm::kCrc32Unused:
-            modifiedStream << "Crc32Unused";
+        case HashAlgorithm::kCrc32Autosar:
+            modifiedStream << "Crc32Autosar";
             break;
         case HashAlgorithm::kSha1:
             modifiedStream << "Sha1";

score/hash/code/common/algorithms_test.cpp

@@ -124,7 +124,7 @@ TEST(HashIdentify, CorrectSizes)
 {
     const auto expected_sizes_bytes = std::map<const HashAlgorithm, const std::uint8_t>{
         {HashAlgorithm::kCrc32, 4},
-        {HashAlgorithm::kCrc32Unused, 4},
+        {HashAlgorithm::kCrc32Autosar, 4},
         {HashAlgorithm::kSha1, 20},
         {HashAlgorithm::kSha256, 32},
         {HashAlgorithm::kSha384, 48},
@@ -154,8 +154,8 @@ TEST_F(AlgorithmLoggerFixture, CanLogAlgorithms)
     EXPECT_CALL(recorder_, LogStringView(_, {"CRC32:"}));
     EXPECT_CALL(recorder_, LogStringView(_, {"Crc32"}));
 
-    EXPECT_CALL(recorder_, LogStringView(_, {"CRC32 UNUSED:"}));
-    EXPECT_CALL(recorder_, LogStringView(_, {"Crc32Unused"}));
+    EXPECT_CALL(recorder_, LogStringView(_, {"CRC32 AUTOSAR:"}));
+    EXPECT_CALL(recorder_, LogStringView(_, {"Crc32Autosar"}));
 
     EXPECT_CALL(recorder_, LogStringView(_, {"SHA-1:"}));
     EXPECT_CALL(recorder_, LogStringView(_, {"Sha1"}));
@@ -181,7 +181,7 @@ TEST_F(AlgorithmLoggerFixture, CanLogAlgorithms)
     EXPECT_CALL(recorder_, LogStringView(_, {"}"}));
 
     mw::log::LogInfo() << "CRC32:" << HashAlgorithm::kCrc32;
-    mw::log::LogInfo() << "CRC32 UNUSED:" << HashAlgorithm::kCrc32Unused;
+    mw::log::LogInfo() << "CRC32 AUTOSAR:" << HashAlgorithm::kCrc32Autosar;
     mw::log::LogInfo() << "SHA-1:" << HashAlgorithm::kSha1;
     mw::log::LogInfo() << "SHA-256:" << HashAlgorithm::kSha256;
     mw::log::LogInfo() << "SHA-384:" << HashAlgorithm::kSha384;

score/hash/code/core/BUILD

@@ -50,7 +50,7 @@ cc_library(
         "hash_calculator_mock.h",
     ],
     features = COMPILER_WARNING_FEATURES,
-    visibility = ["@score_baselibs//score/hash:__subpackages__"],
+    visibility = ["//visibility:public"],
     deps = [
         "@score_baselibs//score/hash/code/common",
     ],
@@ -81,5 +81,5 @@ cc_unit_test_suites_for_host_and_qnx(
     test_suites_from_sub_packages = [
         "@score_baselibs//score/hash/code/core/factory/impl:unit_tests",
     ],
-    visibility = ["//visibility:public"],  # platform_only
+    visibility = ["//visibility:public"],
 )

score/hash/code/core/factory/BUILD

@@ -44,7 +44,7 @@ cc_library(
         "hash_calculator_factory_mock.h",
     ],
     features = COMPILER_WARNING_FEATURES,
-    visibility = ["@score_baselibs//score/hash:__subpackages__"],
+    visibility = ["//visibility:public"],
     deps = [
         ":factory",
     ],

score/hash/code/core/factory/impl/BUILD

@@ -13,14 +13,26 @@
 
 load("@rules_cc//cc:defs.bzl", "cc_library", "cc_test")
 load("@score_baselibs//:bazel/unit_tests.bzl", "cc_unit_test_suites_for_host_and_qnx")
-load(":custom.bzl", "load_custom_targets", "load_custom_test_suites")
 
 COMPILER_WARNING_FEATURES = [
     "treat_warnings_as_errors",
     "strict_warnings",
     "additional_warnings",
 ]
 
+cc_library(
+    name = "factory_headers",
+    hdrs = [
+        "hash_calculator_factory.h",
+        "safe_hash_calculator_factory.h",
+    ],
+    visibility = ["//visibility:public"],
+    deps = [
+        "@score_baselibs//score/hash/code/core/factory",
+        "@score_baselibs//score/hash/code/openssl:openssl_cal",
+    ],
+)
+
 cc_library(
     name = "hash_impl_ieee",
     srcs = [
@@ -57,8 +69,13 @@ cc_library(
     ],
 )
 
-# Other options:
-# "@score_baselibs//score/hash/code/core/factory/impl:hash_impl_autosar"
+# Extension point:
+# `crc_variant` and `safe_crc_variant` are provided as extension points,
+# meaning that one may replace them with custom implementations that
+# provide different polynomials. To do so, define alternate `cc_library`
+# targets that reuse the generic CRC implementation pattern from
+# `//score/hash/code/crc:crc_ieee`, provide the desired polynomial
+# configuration, and override these two targets in `.bazelrc`.
 label_flag(
     name = "crc_variant",
     build_setting_default = ":hash_impl_ieee",
@@ -67,8 +84,6 @@ label_flag(
     ],
 )
 
-# Other options:
-# "@score_baselibs//score/hash/code/core/factory/impl:safe_hash_impl_autosar"
 label_flag(
     name = "safe_crc_variant",
     build_setting_default = ":safe_hash_impl_ieee",
@@ -96,8 +111,6 @@ cc_test(
 
 cc_unit_test_suites_for_host_and_qnx(
     name = "unit_tests",
-    cc_unit_tests = [":unit_test"] + load_custom_test_suites(),
-    visibility = ["//visibility:public"],  # platform_only
+    cc_unit_tests = [":unit_test"],
+    visibility = ["//visibility:public"],
 )
-
-load_custom_targets()

score/hash/code/core/factory/impl/custom.bzl

@@ -61,7 +61,7 @@ Result<std::unique_ptr<IHashCalculator>> HashCalculatorFactory::CreateHashCalcul
                 std::make_unique<OpensslHashCalculator>(std::move(*digest)));
             break;
         }
-        case HashAlgorithm::kCrc32Unused:
+        case HashAlgorithm::kCrc32Autosar:
         case HashAlgorithm::kNone:
         case HashAlgorithm::kLast:
         default: