Fix Redundant Bundle Validation checks (#921)

Signed-off-by: Shivam Negi <snegi@mathworks.com>
CppMicroServices · Sep 22, 2023 · 1760c69 · 1760c69 · github-actions · Sep 22, 2023
1 parent 1f729ee
commit 1760c69
Show file tree

Hide file tree

Showing 59 changed files with 1,157 additions and 55 deletions.
diff --git a/compendium/DeclarativeServices/src/manager/BundleLoader.cpp b/compendium/DeclarativeServices/src/manager/BundleLoader.cpp
@@ -20,6 +20,8 @@
 
   =============================================================================*/
 
+#include "cppmicroservices/SecurityException.h"
+
 #include "cppmicroservices/Bundle.h"
 #include "cppmicroservices/Constants.h"
 #include "cppmicroservices/SharedLibrary.h"
@@ -102,6 +104,26 @@ namespace cppmicroservices
             }
             else
             {
+                Any func = fromBundle.GetBundleContext().GetProperty(
+                    cppmicroservices::Constants::FRAMEWORK_BUNDLE_VALIDATION_FUNC);
+                try
+                {
+                    if (!func.Empty()
+                        && !any_cast<std::function<bool(cppmicroservices::Bundle const&)>>(func)(fromBundle))
+                    {
+                        std::string errMsg("Bundle at location " + bundleLoc + " failed bundle validation.");
+                        throw SecurityException{ std::move(errMsg), fromBundle };
+                    }
+                }
+                catch (cppmicroservices::SecurityException const&)
+                {
+                    throw;
+                }
+                catch (...)
+                {
+                    throw SecurityException { "The bundle validation callback threw an exception", fromBundle};
+                }
+
                 SharedLibrary sh(bundleLoc);
                 try
                 {

diff --git a/compendium/DeclarativeServices/src/manager/ComponentConfigurationImpl.cpp b/compendium/DeclarativeServices/src/manager/ComponentConfigurationImpl.cpp
@@ -21,7 +21,6 @@
   =============================================================================*/
 
 #include "cppmicroservices/FrameworkFactory.h"
-#include "cppmicroservices/SecurityException.h"
 
 #include "../ConfigurationListenerImpl.hpp"
 #include "BundleLoader.hpp"
@@ -488,29 +487,6 @@ namespace cppmicroservices
         InstanceContextPair
         ComponentConfigurationImpl::CreateAndActivateComponentInstanceHelper(cppmicroservices::Bundle const& bundle)
         {
-            Any func = this->bundle.GetBundleContext().GetProperty(
-                cppmicroservices::Constants::FRAMEWORK_BUNDLE_VALIDATION_FUNC);
-
-            try
-            {
-                if (!func.Empty()
-                    && !any_cast<std::function<bool(cppmicroservices::Bundle const&)>>(func)(this->bundle))
-                {
-                    std::string errMsg("Bundle at location ");
-                    errMsg += this->bundle.GetLocation();
-                    errMsg += " failed bundle validation.";
-                    throw SecurityException { std::move(errMsg), this->bundle };
-                }
-            }
-            catch (cppmicroservices::SecurityException const&)
-            {
-                throw;
-            }
-            catch (...)
-            {
-                throw SecurityException { "The bundle validation callback threw an exception", this->bundle };
-            }
-
             auto componentInstance = CreateComponentInstance();
             auto ctxt = std::make_shared<ComponentContextImpl>(shared_from_this(), bundle);
             /*

diff --git a/compendium/DeclarativeServices/test/gtest/TestBundleValidation.cpp b/compendium/DeclarativeServices/test/gtest/TestBundleValidation.cpp
diff --git a/compendium/test_bundles/CMakeLists.txt b/compendium/test_bundles/CMakeLists.txt
@@ -16,6 +16,17 @@ add_subdirectory(TestBundleDSDGMU)
 add_subdirectory(TestBundleDSDGOU)
 add_subdirectory(TestBundleDSSLE1)
 add_subdirectory(TestBundleDSSLE2)
+add_subdirectory(TestBundleDSTBV1)
+add_subdirectory(TestBundleDSTBV1_1)
+add_subdirectory(TestBundleDSTBV1_2)
+add_subdirectory(TestBundleDSTBV1_3)
+add_subdirectory(TestBundleDSTBV1_4)
+add_subdirectory(TestBundleDSTBV1_5)
+add_subdirectory(TestBundleDSTBV2)
+add_subdirectory(TestBundleDSTBV3)
+add_subdirectory(TestBundleDSTBV3_1)
+add_subdirectory(TestBundleDSTBV4)
+add_subdirectory(TestBundleDSTBV5)
 add_subdirectory(TestBundleDSTOI1)
 add_subdirectory(TestBundleDSTOI10)
 add_subdirectory(TestBundleDSTOI12)

diff --git a/compendium/test_bundles/TestBundleDSTBV1/CMakeLists.txt b/compendium/test_bundles/TestBundleDSTBV1/CMakeLists.txt
@@ -0,0 +1,7 @@
+usFunctionCreateDSTestBundle(TestBundleDSTBV1)
+
+usFunctionCreateTestBundleWithResources(TestBundleDSTBV1
+  SOURCES src/ServiceImpl.cpp ${_glue_file}
+  RESOURCES manifest.json
+  BUNDLE_SYMBOLIC_NAME TestBundleDSTBV1
+  OTHER_LIBRARIES usTestInterfaces usServiceComponent)
diff --git a/compendium/test_bundles/TestBundleDSTBV1/resources/manifest.json b/compendium/test_bundles/TestBundleDSTBV1/resources/manifest.json
@@ -0,0 +1,18 @@
+{
+  "bundle.symbolic_name": "TestBundleDSTBV1",
+  "bundle.name": "TestBundleDSTBV1",
+  "bundle.activator": false,
+  "scr": {
+    "version": 1,
+    "components": [
+      {
+        "enabled": true,
+        "immediate": true,
+        "implementation-class": "sample::ServiceComponentBV1",
+        "service": {
+          "interfaces": [ "test::Interface1" ]
+        }
+      }
+    ]
+  }
+}
diff --git a/compendium/test_bundles/TestBundleDSTBV1/src/ServiceComponents.hpp b/compendium/test_bundles/TestBundleDSTBV1/src/ServiceComponents.hpp
@@ -0,0 +1,6 @@
+#ifndef SERVICECOMPONENTS_HPP
+#define SERVICECOMPONENTS_HPP
+
+#include "ServiceImpl.hpp"
+
+#endif
diff --git a/compendium/test_bundles/TestBundleDSTBV1/src/ServiceImpl.cpp b/compendium/test_bundles/TestBundleDSTBV1/src/ServiceImpl.cpp
@@ -0,0 +1,33 @@
+/*=============================================================================
+
+  Library: CppMicroServices
+
+  Copyright (c) The CppMicroServices developers. See the COPYRIGHT
+  file at the top-level directory of this distribution and at
+  https://github.com/CppMicroServices/CppMicroServices/COPYRIGHT .
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+=============================================================================*/
+#include "ServiceImpl.hpp"
+
+namespace sample
+{
+    ServiceComponentBV1::~ServiceComponentBV1() {}
+
+    std::string
+    ServiceComponentBV1::Description()
+    {
+        return STRINGIZE(US_BUNDLE_NAME);
+    }
+} // namespace sample
diff --git a/compendium/test_bundles/TestBundleDSTBV1/src/ServiceImpl.hpp b/compendium/test_bundles/TestBundleDSTBV1/src/ServiceImpl.hpp
@@ -0,0 +1,17 @@
+#ifndef _SERVICE_IMPL_HPP_
+#define _SERVICE_IMPL_HPP_
+
+#include "TestInterfaces/Interfaces.hpp"
+
+namespace sample
+{
+    class ServiceComponentBV1 : public test::Interface1
+    {
+      public:
+        ServiceComponentBV1() = default;
+        ~ServiceComponentBV1() override;
+        std::string Description() override;
+    };
+} // namespace sample
+
+#endif // _SERVICE_IMPL_HPP_
diff --git a/compendium/test_bundles/TestBundleDSTBV1_1/CMakeLists.txt b/compendium/test_bundles/TestBundleDSTBV1_1/CMakeLists.txt
@@ -0,0 +1,8 @@
+usFunctionCreateDSTestBundle(TestBundleDSTBV1_1)
+
+usFunctionCreateTestBundleWithResources(TestBundleDSTBV1_1
+  SOURCES src/ServiceImpl.cpp ${_glue_file}
+  RESOURCES manifest.json
+  BUNDLE_SYMBOLIC_NAME TestBundleDSTBV1_1
+  OTHER_LIBRARIES usTestInterfaces usServiceComponent)
+
diff --git a/compendium/test_bundles/TestBundleDSTBV1_1/resources/manifest.json b/compendium/test_bundles/TestBundleDSTBV1_1/resources/manifest.json
@@ -0,0 +1,21 @@
+{
+  "bundle.symbolic_name": "TestBundleDSTBV1_1",
+  "scr": {
+    "version": 1,
+    "components": [
+      {
+        "implementation-class": "sample::ServiceComponentBV1_1",
+        "service": {
+          "interfaces": [ "test::Interface2" ]
+        },
+        "references": [
+          {
+            "name": "foo",
+            "interface": "test::Interface1"
+          }
+        ],
+        "inject-references": false
+      }
+    ]
+  }
+}
diff --git a/compendium/test_bundles/TestBundleDSTBV1_1/src/ServiceComponents.hpp b/compendium/test_bundles/TestBundleDSTBV1_1/src/ServiceComponents.hpp
@@ -0,0 +1,6 @@
+#ifndef SERVICECOMPONENTS_HPP
+#define SERVICECOMPONENTS_HPP
+
+#include "ServiceImpl.hpp"
+
+#endif
diff --git a/compendium/test_bundles/TestBundleDSTBV1_1/src/ServiceImpl.cpp b/compendium/test_bundles/TestBundleDSTBV1_1/src/ServiceImpl.cpp
@@ -0,0 +1,48 @@
+#include "ServiceImpl.hpp"
+
+namespace sample
+{
+    void
+    ServiceComponentBV1_1::Activate(std::shared_ptr<ComponentContext> const& ctxt)
+    {
+        foo = ctxt->LocateService<test::Interface1>("foo");
+    }
+
+    void
+    ServiceComponentBV1_1::Deactivate(std::shared_ptr<ComponentContext> const&)
+    {
+        foo = nullptr;
+    }
+
+    std::string
+    ServiceComponentBV1_1::ExtendedDescription()
+    {
+        if (!foo)
+        {
+            throw std::runtime_error("Dependency not available");
+        }
+        std::string result(STRINGIZE(US_BUNDLE_NAME));
+        result.append("depends on ");
+        result.append(foo->Description());
+        return result;
+    }
+
+    void
+    ServiceComponentBV1_1::Bindfoo(std::shared_ptr<test::Interface1> const& theFoo)
+    {
+        if (foo != theFoo)
+        {
+            foo = theFoo;
+        }
+    }
+
+    void
+    ServiceComponentBV1_1::Unbindfoo(std::shared_ptr<test::Interface1> const& theFoo)
+    {
+        if (foo == theFoo)
+        {
+            foo = nullptr;
+        }
+    }
+
+} // namespace sample
diff --git a/compendium/test_bundles/TestBundleDSTBV1_1/src/ServiceImpl.hpp b/compendium/test_bundles/TestBundleDSTBV1_1/src/ServiceImpl.hpp
@@ -0,0 +1,28 @@
+#ifndef _SERVICE_IMPL_HPP_
+#define _SERVICE_IMPL_HPP_
+
+#include "TestInterfaces/Interfaces.hpp"
+#include "cppmicroservices/servicecomponent/ComponentContext.hpp"
+
+using ComponentContext = cppmicroservices::service::component::ComponentContext;
+
+namespace sample
+{
+    class ServiceComponentBV1_1 : public test::Interface2
+    {
+      public:
+        ServiceComponentBV1_1() = default;
+        std::string ExtendedDescription() override;
+        void Activate(std::shared_ptr<ComponentContext> const&);
+        void Deactivate(std::shared_ptr<ComponentContext> const&);
+        ~ServiceComponentBV1_1() = default;
+
+        void Bindfoo(std::shared_ptr<test::Interface1> const&);
+        void Unbindfoo(std::shared_ptr<test::Interface1> const&);
+
+      private:
+        std::shared_ptr<test::Interface1> foo;
+    };
+} // namespace sample
+
+#endif // _SERVICE_IMPL_HPP_
diff --git a/compendium/test_bundles/TestBundleDSTBV1_2/CMakeLists.txt b/compendium/test_bundles/TestBundleDSTBV1_2/CMakeLists.txt
@@ -0,0 +1,8 @@
+usFunctionCreateDSTestBundle(TestBundleDSTBV1_2)
+
+usFunctionCreateTestBundleWithResources(TestBundleDSTBV1_2
+  SOURCES src/ServiceImpl.cpp ${_glue_file}
+  RESOURCES manifest.json
+  BUNDLE_SYMBOLIC_NAME TestBundleDSTBV1_2
+  OTHER_LIBRARIES usTestInterfaces usServiceComponent usServiceComponent)
+
diff --git a/compendium/test_bundles/TestBundleDSTBV1_2/resources/manifest.json b/compendium/test_bundles/TestBundleDSTBV1_2/resources/manifest.json
@@ -0,0 +1,23 @@
+{
+  "bundle.symbolic_name": "TestBundleDSTBV1_2",
+  "scr": {
+    "version": 1,
+    "components": [
+      {
+        "immediate": true,
+        "implementation-class": "sample::ServiceComponentBV1_2",
+        "service": {
+          "interfaces": [ "test::Interface2" ]
+        },
+        "references": [
+          {
+            "name": "foo",
+            "policy": "Dynamic",
+            "interface": "test::Interface1"
+          }
+        ],
+        "inject-references": false
+      }
+    ]
+  }
+}
diff --git a/compendium/test_bundles/TestBundleDSTBV1_2/src/ServiceComponents.hpp b/compendium/test_bundles/TestBundleDSTBV1_2/src/ServiceComponents.hpp
@@ -0,0 +1,6 @@
+#ifndef SERVICECOMPONENTS_HPP
+#define SERVICECOMPONENTS_HPP
+
+#include "ServiceImpl.hpp"
+
+#endif
diff --git a/compendium/test_bundles/TestBundleDSTBV1_2/src/ServiceImpl.cpp b/compendium/test_bundles/TestBundleDSTBV1_2/src/ServiceImpl.cpp
@@ -0,0 +1,48 @@
+#include "ServiceImpl.hpp"
+#include <iostream>
+
+namespace sample
+{
+
+    void
+    ServiceComponentBV1_2::Activate(std::shared_ptr<ComponentContext> const& /*ctxt*/)
+    {
+    }
+
+    void
+    ServiceComponentBV1_2::Deactivate(std::shared_ptr<ComponentContext> const&)
+    {
+    }
+
+    std::string
+    ServiceComponentBV1_2::ExtendedDescription()
+    {
+        if (!foo)
+        {
+            throw std::runtime_error("Dependency not available");
+        }
+        std::string result(STRINGIZE(US_BUNDLE_NAME));
+        result.append("depends on ");
+        result.append(foo->Description());
+        return result;
+    }
+
+    void
+    ServiceComponentBV1_2::Bindfoo(std::shared_ptr<test::Interface1> const& theFoo)
+    {
+        if (foo != theFoo)
+        {
+            foo = theFoo;
+        }
+    }
+
+    void
+    ServiceComponentBV1_2::Unbindfoo(std::shared_ptr<test::Interface1> const& theFoo)
+    {
+        if (foo == theFoo)
+        {
+            foo = nullptr;
+        }
+    }
+
+} // namespace sample