consistency check improved

ref #9784

All empty, automatic and unlocked clusters are checked and released at startup and at change of a device configuration.

src/model/autoclustermaintenance.cpp

@@ -142,6 +142,15 @@ void AutoClusterMaintenance::joinIdenticalClusters ()
}
} /* joinIdenticalClusters */
+void AutoClusterMaintenance::cleanupEmptyCluster()
+{
+  assert(m_pApartment);
+  boost::recursive_mutex::scoped_lock scoped_lock(m_pApartment->getMutex());
+
+  removeEmptyAutomaticCluster();
+
+} /* removeEmptyAutomaticCluster */
+
void AutoClusterMaintenance::moveClusterDevices(boost::shared_ptr<Cluster> _clusterSource, boost::shared_ptr<Cluster> _clusterDestination)
{
assert(m_pApartment);
@@ -183,12 +192,20 @@ void AutoClusterMaintenance::removeDeviceFromCluster(Device &_device, boost::sha
{
_cluster->removeDevice(_device);
busRemoveFromGroup(_device, _cluster);
-  if (_cluster->releaseCluster()) {
-    busUpdateCluster(_cluster);
+  removeEmptyAutomaticCluster();
+} /* removeDeviceFromCluster */
+void AutoClusterMaintenance::removeEmptyAutomaticCluster()
+{
+  // remove empty, automatic and unlocked clusters
+  foreach (boost::shared_ptr<Cluster> cluster, m_pApartment->getClusters()) {
+    if (cluster->isAutomatic() && !cluster->isConfigurationLocked()) {
+      if (cluster->releaseCluster()) {
+        busUpdateCluster(cluster);
+      }
+    }
}
-
-} /* removeDeviceFromCluster */
+} /* removeEmptyAutomaticCluster */
void AutoClusterMaintenance::assignDeviceToCluster(Device &_device, boost::shared_ptr<Cluster> _cluster)
{

src/model/autoclustermaintenance.h

@@ -49,6 +49,7 @@ public:
void consistencyCheck(Device &_device);
void joinIdenticalClusters();
+  void cleanupEmptyCluster();
protected:
boost::shared_ptr<Cluster> findOrCreateCluster(CardinalDirection_t _cardinalDirection, WindProtectionClass_t _protection); // protected for unit tests
@@ -61,6 +62,7 @@ private:
void removeInvalidAssignments(Device  &_device);
std::vector<boost::shared_ptr<Cluster> > getUnlockedClusterAssignment(Device &_device);
int getFirstLockedClusterAssignment(Device &_device);
+  void removeEmptyAutomaticCluster();
void busAddToGroup(Device &_device, boost::shared_ptr<Cluster> _cluster);
void busRemoveFromGroup(Device &_device, boost::shared_ptr<Cluster> _cluster);

src/model/modelmaintenance.cpp

@@ -935,6 +935,7 @@ namespace dss {
boost::shared_ptr<Device> device = ref.getDevice();
maintenance.consistencyCheck(*device.get());
}
+        maintenance.cleanupEmptyCluster();
boost::shared_ptr<Event> dsMeterReadyEvent = boost::make_shared<Event>("dsMeter_ready");
dsMeterReadyEvent->setProperty("dsMeter", dsuid2str(mod->getDSID()));

tests/model-autocluster_tests.cpp

@@ -598,4 +598,40 @@ BOOST_AUTO_TEST_CASE(unassignmentCheck) {
}
}
+
+BOOST_AUTO_TEST_CASE(checkCleanupEmptyCluster) {
+  Apartment apt1(NULL);
+  InstanceHelper helper(&apt1);
+  AccessAutoClusterMaintenance clusterMaint(&apt1);
+
+  // create empty automatic clusters
+  foreach (boost::shared_ptr<Cluster> cluster, apt1.getClusters()) {
+    cluster->setLocation(cd_east);
+    cluster->setProtectionClass(wpc_class_3);
+    cluster->setStandardGroupID(DEVICE_CLASS_GR);
+    cluster->setName("test");
+    cluster->setAutomatic(true);
+  }
+
+  {
+    std::vector<boost::shared_ptr<Cluster> > clusters = apt1.getClusters();
+    std::vector<boost::shared_ptr<Cluster> > usedClusters;
+    std::vector<boost::shared_ptr<Cluster> > automaticClusters;
+    filterClusters(clusters, &usedClusters, &automaticClusters);
+    BOOST_CHECK_EQUAL(usedClusters.size(), MAX_CLUSTERS);
+    BOOST_CHECK_EQUAL(automaticClusters.size(), MAX_CLUSTERS);
+  }
+
+  clusterMaint.cleanupEmptyCluster();
+
+  {
+    std::vector<boost::shared_ptr<Cluster> > clusters = apt1.getClusters();
+    std::vector<boost::shared_ptr<Cluster> > usedClusters;
+    std::vector<boost::shared_ptr<Cluster> > automaticClusters;
+    filterClusters(clusters, &usedClusters, &automaticClusters);
+    BOOST_CHECK_EQUAL(usedClusters.size(), 0);
+    BOOST_CHECK_EQUAL(automaticClusters.size(), 0);
+  }
+}
+
BOOST_AUTO_TEST_SUITE_END()