HONEYCOMB-207 : Configurable modules list for distributions

Export list of modules for built distribution on compile time according
to distribution.modules property to ***module-config.txt
Load aggregated set of modules on start from all descriptors in /modules
folder

Change-Id: Icdeb23536aee3a243a221d3f2ec5f340d387764e
Signed-off-by: Jan Srnicek <jsrnicek@cisco.com>

3 files changed, 160 insertions, 1 deletions

diff --git a/infra/minimal-distribution/src/test/java/io/fd/honeycomb/infra/distro/ActiveModuleProviderTest.java b/infra/minimal-distribution/src/test/java/io/fd/honeycomb/infra/distro/ActiveModuleProviderTest.java
new file mode 100644
index 000000000..bdadc5bd8
--- /dev/null
+++ b/infra/minimal-distribution/src/test/java/io/fd/honeycomb/infra/distro/ActiveModuleProviderTest.java
@@ -0,0 +1,91 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * 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.
+ */
+
+package io.fd.honeycomb.infra.distro;
+
+
+import static com.google.common.collect.ImmutableList.of;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.empty;
+import static org.hamcrest.Matchers.hasItem;
+import static org.hamcrest.Matchers.hasItems;
+import static org.hamcrest.Matchers.hasSize;
+import static org.hamcrest.Matchers.isA;
+import static org.hamcrest.core.Is.is;
+
+import com.google.common.collect.ImmutableList;
+import com.google.inject.Module;
+import java.util.List;
+import java.util.Set;
+import org.junit.Test;
+
+public class ActiveModuleProviderTest {
+
+    @Test
+    public void testLoadActiveModulesSuccessfull() {
+        final ImmutableList rawResources = of(
+                "// this should be skipped",
+                "// io.fd.honeycomb.infra.distro.Modules$ChildModule1",
+                "               io.fd.honeycomb.infra.distro.Modules$ChildModule2",
+                "io.fd.honeycomb.infra.distro.Modules$ChildModule3     ",
+                "io.fd.honeycomb.infra.distro.Modules$ChildModule3",
+                "io.fd.honeycomb.infra.distro.Modules$NonModule"
+        );
+
+        final Set<Module> activeModules = ActiveModuleProvider.loadActiveModules(rawResources);
+
+        // first and second line should be ignored due to comment
+        // second,third,and fourth are valid,but should reduce module count to 2,because of duplicity
+        // last one does is not ancestor of Module, so it should be ignored/skipped
+        assertThat(activeModules, hasSize(2));
+        //hasItems or containsInAnyOrder does not have/is deprecated in variant with matcher
+        assertThat(activeModules, hasItem(isA(io.fd.honeycomb.infra.distro.Modules.ChildModule2.class)));
+        assertThat(activeModules, hasItem(isA(io.fd.honeycomb.infra.distro.Modules.ChildModule3.class)));
+    }
+
+    @Test(expected = IllegalStateException.class)
+    public void testLoadActiveModulesFailed() {
+        final ImmutableList rawResources = of(
+                "// this should be skipped",
+                "// io.fd.honeycomb.infra.distro.Modules$ChildModule1",
+                "               io.fd.honeycomb.infra.distro.Modules$ChildModule2",
+                "### io.fd.honeycomb.infra.distro.Modules$ChildModule3     ",// it should fail because of this
+                "io.fd.honeycomb.infra.distro.Modules$ChildModule3",
+                "io.fd.honeycomb.infra.distro.Modules$NonModule"
+        );
+
+        ActiveModuleProvider.loadActiveModules(rawResources);
+    }
+
+    @Test
+    public void testAggregateResourcesNonEmpty() {
+        final List<String> aggregatedResources =
+                ActiveModuleProvider.aggregateResources("./modules", this.getClass().getClassLoader());
+        assertThat(aggregatedResources, hasSize(5));
+        assertThat(aggregatedResources, hasItems("        Non-commented non-trimmed",
+                "//Commented",
+                "// Commented non-trimmed",
+                "Not commented",
+                "// Line from second file"));
+    }
+
+    @Test
+    public void testAggregateResourcesEmpty() {
+        assertThat(ActiveModuleProvider.aggregateResources("/non-existing-folder", this.getClass().getClassLoader()),
+                is(empty()));
+    }
+
+}
diff --git a/infra/minimal-distribution/src/test/java/io/fd/honeycomb/infra/distro/BaseMinimalDistributionTest.java b/infra/minimal-distribution/src/test/java/io/fd/honeycomb/infra/distro/BaseMinimalDistributionTest.java
index 61042868f..8a8ddc3ef 100644
--- a/infra/minimal-distribution/src/test/java/io/fd/honeycomb/infra/distro/BaseMinimalDistributionTest.java
+++ b/infra/minimal-distribution/src/test/java/io/fd/honeycomb/infra/distro/BaseMinimalDistributionTest.java
@@ -16,22 +16,35 @@
 
 package io.fd.honeycomb.infra.distro;
 
+import static com.google.common.collect.ImmutableSet.of;
 import static org.hamcrest.CoreMatchers.containsString;
 import static org.junit.Assert.assertThat;
 import static org.junit.Assert.assertTrue;
 
 import com.google.common.base.Charsets;
 import com.google.common.io.ByteStreams;
+import com.google.inject.Module;
 import com.jcraft.jsch.Channel;
 import com.jcraft.jsch.ChannelSubsystem;
 import com.jcraft.jsch.JSch;
 import com.jcraft.jsch.Session;
 import com.mashape.unirest.http.HttpResponse;
 import com.mashape.unirest.http.Unirest;
+import io.fd.honeycomb.infra.distro.cfgattrs.CfgAttrsModule;
+import io.fd.honeycomb.infra.distro.data.ConfigAndOperationalPipelineModule;
+import io.fd.honeycomb.infra.distro.data.context.ContextPipelineModule;
+import io.fd.honeycomb.infra.distro.initializer.InitializerPipelineModule;
+import io.fd.honeycomb.infra.distro.netconf.NetconfModule;
+import io.fd.honeycomb.infra.distro.netconf.NetconfReadersModule;
+import io.fd.honeycomb.infra.distro.restconf.RestconfModule;
+import io.fd.honeycomb.infra.distro.schema.SchemaModule;
+import io.fd.honeycomb.infra.distro.schema.YangBindingProviderModule;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.Socket;
+import java.util.List;
 import java.util.Properties;
+import java.util.Set;
 import javax.net.ssl.SSLContext;
 import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
 import org.apache.http.conn.ssl.TrustSelfSignedStrategy;
@@ -57,6 +70,17 @@ public class BaseMinimalDistributionTest {
     private static final String NETCONF_NAMESPACE = "urn:ietf:params:xml:ns:netconf:base:1.0";
     private static final int NETCONF_HELLO_WAIT = 2500;
 
+    public static final Set<Module> BASE_MODULES = of(
+            new YangBindingProviderModule(),
+            new SchemaModule(),
+            new ConfigAndOperationalPipelineModule(),
+            new ContextPipelineModule(),
+            new InitializerPipelineModule(),
+            new NetconfModule(),
+            new NetconfReadersModule(),
+            new RestconfModule(),
+            new CfgAttrsModule());
+
     @Before
     public void setUp() throws Exception {
         SSLContext sslcontext = SSLContexts.custom()
@@ -76,7 +100,7 @@ public class BaseMinimalDistributionTest {
      */
     @Test(timeout = 60000)
     public void test() throws Exception {
-        Main.init(Main.BASE_MODULES);
+        Main.init(BASE_MODULES);
 
         LOG.info("Testing Honeycomb base distribution");
         LOG.info("Testing NETCONF TCP");
diff --git a/infra/minimal-distribution/src/test/java/io/fd/honeycomb/infra/distro/Modules.java b/infra/minimal-distribution/src/test/java/io/fd/honeycomb/infra/distro/Modules.java
new file mode 100644
index 000000000..e30fb87ca
--- /dev/null
+++ b/infra/minimal-distribution/src/test/java/io/fd/honeycomb/infra/distro/Modules.java
@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * 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.
+ */
+
+package io.fd.honeycomb.infra.distro;
+
+import com.google.inject.AbstractModule;
+import com.google.inject.Binder;
+import com.google.inject.Module;
+
+public class Modules {
+
+    public static class ChildModule1 implements Module {
+        @Override
+        public void configure(final Binder binder) {
+        }
+    }
+
+    public static class ChildModule2 implements Module {
+        @Override
+        public void configure(final Binder binder) {
+        }
+    }
+
+    public static class ChildModule3 extends AbstractModule {
+        @Override
+        protected void configure() {
+        }
+    }
+
+    public static class NonModule{}
+}