Clean up configs, machine name is generated on startup

Author: MoeweX

README.md

@@ -9,7 +9,7 @@ For some of the tests, a running naming service is required. The naming service
 # Current ToDos / Missing Functionality
 
 ## Startup
-- [ ] A machineName should be dynamically created on Startup (clean up configs)
+- [x] A machineName should be dynamically created on Startup (clean up configs)
 - [x] Run AddMachineToNodeTask (ended up not being a task)
 
 ## Subscription Management incl. Heartbeats

src/main/java/communication/MessageIdEvaluator.java

@@ -39,7 +39,7 @@ public class MessageIdEvaluator {
 	private static Logger logger = Logger.getLogger(MessageIdEvaluator.class.getName());
 
 	static {
-		logger.setLevel(Level.INFO);
+		logger.setLevel(Level.DEBUG);
 	}
 
 	private FBase fBase;

src/main/java/control/Configuration.java

@@ -61,7 +61,6 @@ public Configuration(String configName) {
 
 			properties.load(is);
 			// General
-			machineName = properties.getProperty("machineName");
 			nodeID = new NodeID(properties.getProperty("nodeID"));
 			location = properties.getProperty("location", "Unknown");
 			description = properties.getProperty("description", "Unknown");
@@ -101,7 +100,7 @@ private void checkConsistency() throws IOException {
 		for (int i = 0; i < methods.length; i++) {
 			Method m = methods[i];
 			if (m.getName().startsWith("get")) {
-				if (!m.getName().equals("getAlgorithm")) {
+				if (!m.getName().equals("getAlgorithm") && !m.getName().equals("getMachineName")) {
 					try {
 						Object obj = m.invoke(this);
 						if (obj == null) {
@@ -135,6 +134,10 @@ public NodeConfig buildNodeConfigBasedOnData() {
 
 		return config;
 	}
+	
+	public void setMachineName(String machineName) {
+		this.machineName = machineName;
+	}
 
 	public String getMachineName() {
 		return machineName;

src/main/java/control/FBase.java

@@ -55,17 +55,16 @@ public FBase(String configName) {
 		publisher = new Publisher("tcp://0.0.0.0", configuration.getPublisherPort());
 	}
 
-	public void startup(boolean announce) throws InterruptedException, ExecutionException,
-			TimeoutException, FBaseStorageConnectorException, FBaseCommunicationException,
-			FBaseNamingServiceException {
+	public void startup(boolean announce, boolean backgroundTasks) throws InterruptedException,
+			ExecutionException, TimeoutException, FBaseStorageConnectorException,
+			FBaseCommunicationException, FBaseNamingServiceException {
 		if (Connector.S3.equals(configuration.getDatabaseConnector())) {
 			connector =
-					new S3DBConnector(configuration.getNodeID(), configuration.getMachineName());
+					new S3DBConnector(configuration.getNodeID());
 		} else {
-			connector = new OnHeapDBConnector(configuration.getNodeID(),
-					configuration.getMachineName());
+			connector = new OnHeapDBConnector(configuration.getNodeID());
 		}
-		connector.dbConnection_initiate();
+		configuration.setMachineName(connector.dbConnection_initiate());
 		configAccessHelper = new ConfigAccessHelper(this);
 		taskmanager = new TaskManager(this);
 		if (configuration.getRestPort() > 0) {
@@ -82,36 +81,41 @@ public void startup(boolean announce) throws InterruptedException, ExecutionExce
 		subscriptionRegistry = new SubscriptionRegistry(this);
 		messageIdEvaluator = new MessageIdEvaluator(this);
 		messageIdEvaluator.startup();
-		
+
 		// start putting heartbeats (pulse 0 = default)
 		taskmanager.startBackgroundPutHeartbeatTask(0);
-		
+
 		// add machine to node
 		if (announce) {
 			announceMachineAdditionToNode();
 		}
-		
+
 		// start other background tasks (interval 0 = default)
-		taskmanager.startBackgroundPollLatesConfigurationDataForResponsibleKeygroupsTask(0);
-		taskmanager.startBackgroundCheckKeygroupConfigurationsOnUpdatesTask(0);
-		taskmanager.startDetectMissingHeartbeatsTask(0, 0);
-		taskmanager.startBackgroundDetectMissingResponsibility(0);
-		taskmanager.startBackgroundDetectLostResponsibility(0);
+		if (backgroundTasks) {
+			taskmanager.startBackgroundPollLatesConfigurationDataForResponsibleKeygroupsTask(0);
+			taskmanager.startBackgroundCheckKeygroupConfigurationsOnUpdatesTask(0);
+			taskmanager.startDetectMissingHeartbeatsTask(0, 0);
+			taskmanager.startBackgroundDetectMissingResponsibility(0);
+			taskmanager.startBackgroundDetectLostResponsibility(0);
+		}
 
 		Thread.sleep(50);
 		logger.info("FBase started, all background tasks up and running.");
 	}
 
-	private void announceMachineAdditionToNode()
-			throws FBaseStorageConnectorException, FBaseCommunicationException,
-			FBaseNamingServiceException {
-		
-		// TODO 1: Tell a node that is already registered about addition (we need a one-to-one here)
+	private void announceMachineAdditionToNode() throws FBaseStorageConnectorException,
+			FBaseCommunicationException, FBaseNamingServiceException {
+
+		// TODO 1: Tell a node that is already registered about addition (we need a one-to-one
+		// here)
 
 	}
 
 	public void tearDown() {
+		// TODO 1: stop all background tasks
+		subscriptionRegistry.deleteAllData();
 		publisher.shutdown();
+		namingServiceSender.shutdown();
 		messageIdEvaluator.tearDown();
 		directMessageReceiver.stopReception();
 		if (server != null) {

src/main/java/control/Starter.java

@@ -13,7 +13,7 @@ public static void main(String[] args)
 			throws FBaseStorageConnectorException, InterruptedException, ExecutionException,
 			TimeoutException, FBaseCommunicationException, FBaseNamingServiceException {
 		FBase fbase = new FBase("local.properties");
-		fbase.startup(true);
+		fbase.startup(true, true); // TODO 2: parse from args
 		fbase.fillWithData();
 	}
 

src/main/java/storageconnector/AbstractDBConnector.java

@@ -47,8 +47,9 @@ protected AbstractDBConnector() {
 	 * called when initializing the connection
 	 * 
 	 * @throws FBaseStorageConnectorException when something goes wrong
+	 * @return the random name for the initialized machine that did not exist yet
 	 */
-	public abstract void dbConnection_initiate() throws FBaseStorageConnectorException;
+	public abstract String dbConnection_initiate() throws FBaseStorageConnectorException;
 
 	/**
 	 * CONNECTION ADMINISTRATION<br<br>

src/main/java/storageconnector/OnHeapDBConnector.java

@@ -70,20 +70,21 @@ public class OnHeapDBConnector extends AbstractDBConnector {
 	private NodeID nodeID = null;
 	private String machineName = null;
 
-	public OnHeapDBConnector(NodeID nodeID, String machineName) {
+	public OnHeapDBConnector(NodeID nodeID) {
 		this.nodeID = nodeID;
-		this.machineName = machineName;
 	}
 
 	/*
 	 * (non-Javadoc)
 	 * 
 	 * @see storageconnector.AbstractDBConnector#initiateDatabaseConnection()
+	 * Always returns the same name, because always only one machine exists for an on_heap node
 	 */
 	@Override
-	public void dbConnection_initiate() throws FBaseStorageConnectorException {
+	public String dbConnection_initiate() throws FBaseStorageConnectorException {
 		log.info("Connector initialized.");
-
+		this.machineName = "M1";
+		return this.machineName;
 	}
 
 	/*

src/main/java/storageconnector/S3DBConnector.java

@@ -57,9 +57,8 @@ private enum Suffix {
 	private NodeID nodeID = null;
 	private String machineName = null;
 
-	public S3DBConnector(NodeID nodeID, String machineName) {
+	public S3DBConnector(NodeID nodeID) {
 		this.nodeID = nodeID;
-		this.machineName = machineName;
 		suffixMap = new HashMap<>();
 		suffixMap.put(Suffix.DATA_RECORD, ".data-records");
 		suffixMap.put(Suffix.KEYGROUP, ".keygroup-configs");
@@ -70,8 +69,8 @@ public S3DBConnector(NodeID nodeID, String machineName) {
 		suffixMap.put(Suffix.MESSAGE_HISTORY, ".message-history");
 	}
 
-	public S3DBConnector(NodeID nodeID, String machineName, String bucketName) {
-		this(nodeID, machineName);
+	public S3DBConnector(NodeID nodeID, String bucketName) {
+		this(nodeID);
 		this.bucketPrefix = bucketName;
 	}
 
@@ -106,6 +105,9 @@ public void dbConnection_initiate() throws FBaseStorageConnectorException {
 				}
 			}
 		}
+		// TODO S3: set this.machinename to generated name
+		
+		return this.machineName;
 	}
 
 	public void deleteBuckets() throws FBaseStorageConnectorException {

src/main/resources/sample_config.properties

@@ -1,17 +1,14 @@
 ! A sample configuration file for FBase
 ! You should create a local.properties based on this
 
-!!! Machine specific data (each machine of the node can have different values here) !!!
-machineName: <the machine name (MANDATORY)>
-messageHistorySize: <total number of last published messages stored>
-
 !!! Node specific data (has to be equal on all nodes) !!!
 
 ! General
 nodeID: <nodeID of the node this machine is a part of (MANDATORY)>
 location: <location of the node>
 description: <description of the node>
 databaseConnector: <the used database connector (ON_HEAP or S3)>
+messageHistorySize: <total number of last published messages stored>
 
 ! Communication
 restPort: <the port on which the rest interface is available>

src/test/java/communication/DirectMessageSenderAndReceiverTest.java

@@ -22,6 +22,7 @@
 import model.data.DataRecord;
 import model.data.KeygroupID;
 import model.data.MessageID;
+import tasks.FBaseFactory;
 
 /**
  * Test for {@link DirectMessageSender} and {@link DirectMessageReceiver}.
@@ -31,7 +32,8 @@
  */
 public class DirectMessageSenderAndReceiverTest {
 
-	private static Logger logger = Logger.getLogger(DirectMessageSenderAndReceiverTest.class.getName());
+	private static Logger logger =
+			Logger.getLogger(DirectMessageSenderAndReceiverTest.class.getName());
 
 	FBase fBase = null;
 	DirectMessageSender directMessageSender = null;
@@ -48,12 +50,11 @@ public static void tearDownAfterClass() throws Exception {
 
 	@Before
 	public void setUp() throws Exception {
-		fBase = new FBase("MessageSenderAndReceiverTest_Config.properties");
-		fBase.startup(false);
+		fBase = FBaseFactory.basic(1, false, false);
 		myNode = fBase.configuration.buildNodeConfigBasedOnData();
 		// put my own configuration in database
 		fBase.connector.nodeConfig_put(myNode.getNodeID(), myNode);
-		
+
 		directMessageSender = new DirectMessageSender(myNode, fBase);
 		KeygroupConfig keygroupConfig =
 				new KeygroupConfig(keygroupID, "testscret", EncryptionAlgorithm.AES);

src/test/java/communication/NamingServiceSenderTest.java

@@ -39,14 +39,14 @@
 import model.messages.Envelope;
 import model.messages.Message;
 import model.messages.ResponseCode;
+import tasks.FBaseFactory;
 
 public class NamingServiceSenderTest {
 
 	private static Logger logger = Logger.getLogger(NamingServiceSenderTest.class.getName());
 
 	private static ExecutorService executor;
 	private static FBase fbase;
-	private static final String configName = "NamingServiceSenderTest_Config.properties";
 	private static final String ownNodeConfigJSONPath =
 			"src/test/resources/NamingServiceSenderTest_NodeConfig.json";
 
@@ -61,8 +61,7 @@ public class NamingServiceSenderTest {
 	@BeforeClass
 	public static void setUpBeforeClass() throws Exception {
 		executor = Executors.newCachedThreadPool();
-		fbase = new FBase(configName);
-		fbase.startup(false);
+		fbase = FBaseFactory.namingService(1, false, false);
 		localSender = new NamingServiceSender(localAddress, localPort, null);
 		nsSender = new NamingServiceSender(fbase.configuration.getNamingServiceAddress(),
 				fbase.configuration.getNamingServicePort(), fbase);

src/test/java/communication/SubscriberTest.java

@@ -23,6 +23,7 @@
 import model.data.DataIdentifier;
 import model.data.DataRecord;
 import model.messages.Message;
+import tasks.FBaseFactory;
 
 public class SubscriberTest {
 
@@ -47,8 +48,7 @@ public static void setUpBeforeClass() throws Exception {
 		contextPub = ZMQ.context(1);
 		publisher = contextPub.socket(ZMQ.PUB);
 		publisher.bind(address + ":" + port);
-		fBase = new FBase("SubscriberTest.properties");
-		fBase.startup(false);
+		fBase = FBaseFactory.basic(1, false, false);
 	}
 
 	@Before

src/test/java/scenario/TwoNodeScenario.java

@@ -33,6 +33,7 @@
 import model.data.DataRecord;
 import model.data.KeygroupID;
 import model.data.MessageID;
+import tasks.FBaseFactory;
 import tasks.TaskManager.TaskName;
 
 public class TwoNodeScenario {
@@ -59,12 +60,8 @@ public static void tearDownAfterClass() throws Exception {
 
 	@Before
 	public void setUp() throws Exception {
-		fbase1 = new FBase("TwoNodeScenario_1.properties");
-		fbase1.startup(false);
-		fbase1.taskmanager.storeHistory();
-		fbase2 = new FBase("TwoNodeScenario_2.properties");
-		fbase2.startup(false);
-		fbase2.taskmanager.storeHistory();
+		fbase1 = FBaseFactory.namingService(1, false, false);
+		fbase2 = FBaseFactory.namingService(2, false, false);
 
 		nConfig1 = fbase1.configuration.buildNodeConfigBasedOnData();
 		nConfig2 = fbase2.configuration.buildNodeConfigBasedOnData();

src/test/java/storageconnector/S3DBConnectorTest.java

@@ -50,7 +50,7 @@ public static void tearDownAfterClass() throws Exception {
 
 	@Before
 	public void setUp() throws Exception {
-		connector = new S3DBConnector(new NodeID("N1"), "M1",
+		connector = new S3DBConnector(new NodeID("N1"),
 				"de.hasenburg.fbase.s3dbconnector-testbucket");
 		connector.dbConnection_initiate();
 		keygroupID1 = new KeygroupID("smartlight", "h1", "lightning");

src/test/java/tasks/B_CheckKeygroupConfigurationsOnUpdatesTaskTest.java

@@ -49,9 +49,7 @@ public void test()
 			throws FBaseStorageConnectorException, InterruptedException, ExecutionException,
 			TimeoutException, FBaseCommunicationException, FBaseNamingServiceException {
 		logger.debug("-------Starting test-------");
-		FBase fbase = new FBase(null);
-		fbase.startup(false);
-		fbase.taskmanager.storeHistory();
+		FBase fbase = FBaseFactory.basic(1, false, false);
 		KeygroupID id = new KeygroupID("app", "tenant", "group");
 		KeygroupConfig config = new KeygroupConfig(id, null, null);
 		config.setVersion(1);
@@ -62,7 +60,8 @@ public void test()
 						+ " should not have been executed so often, ",
 				new Integer(1), fbase.taskmanager.getHistoricTaskNumbers()
 						.get(TaskName.UPDATE_KEYGROUP_SUBSCRIPTIONS));
-		Future<Boolean> task = fbase.taskmanager.startBackgroundCheckKeygroupConfigurationsOnUpdatesTask(1000);
+		Future<Boolean> task =
+				fbase.taskmanager.startBackgroundCheckKeygroupConfigurationsOnUpdatesTask(1000);
 		config.setVersion(2);
 		fbase.connector.keygroupConfig_put(id, config);
 		Thread.sleep(2000);

src/test/java/tasks/FBaseFactory.java

@@ -11,12 +11,24 @@
 public class FBaseFactory {
 
 	private static final String BASIC_PROPERTIES_FILE = "FBaseFactory_Basic";
+	private static final String NAMING_SERVICE_PROPERTIES_FILE = "FBaseFactory_NamingService";
 
-	public static FBase basic(int instanceNumber)
+
+	public static FBase basic(int instanceNumber, boolean announce, boolean backgroundTasks)
 			throws FBaseStorageConnectorException, InterruptedException, ExecutionException,
 			TimeoutException, FBaseCommunicationException, FBaseNamingServiceException {
 		FBase fBase = new FBase(BASIC_PROPERTIES_FILE + instanceNumber + ".properties");
-		fBase.startup(false);
+		fBase.startup(announce, backgroundTasks);
+		fBase.taskmanager.storeHistory();
+		return fBase;
+	}
+
+	public static FBase namingService(int instanceNumber, boolean announce, boolean backgroundTasks)
+			throws FBaseStorageConnectorException, FBaseCommunicationException,
+			FBaseNamingServiceException, InterruptedException, ExecutionException,
+			TimeoutException {
+		FBase fBase = new FBase(NAMING_SERVICE_PROPERTIES_FILE + instanceNumber + ".properties");
+		fBase.startup(announce, backgroundTasks);
 		fBase.taskmanager.storeHistory();
 		return fBase;
 	}

src/test/java/tasks/PutAndDeleteDataRecordTaskTest.java

@@ -48,8 +48,7 @@ public static void tearDownAfterClass() throws Exception {
 
 	@Before
 	public void setUp() throws Exception {
-		fBase = new FBase("PutAndDeleteDataRecordTask_Config.properties");
-		fBase.startup(false);
+		fBase = FBaseFactory.basic(1, false, false);
 		KeygroupConfig keygroupConfig =
 				new KeygroupConfig(keygroupID, "testscret", EncryptionAlgorithm.AES);
 		fBase.taskmanager.runUpdateKeygroupConfigTask(keygroupConfig, false).get(2,

src/test/java/tasks/TaskManagerTest.java

@@ -30,8 +30,7 @@ public class TaskManagerTest {
 
 	@BeforeClass
 	public static void setUpBeforeClass() throws Exception {
-		fBase = new FBase(null);
-		fBase.startup(false);
+		fBase = FBaseFactory.basic(1, false, false);
 		taskmanager = fBase.taskmanager;
 	}