Added Heartbeat feature to core profile

TVolden · TVolden · commit 3d9f8815286f · 2016-05-21T10:47:51.000+02:00
diff --git a/ocpp-test/src/main/java/eu/chargetime/ocpp/test/FakeCentralSystem.java b/ocpp-test/src/main/java/eu/chargetime/ocpp/test/FakeCentralSystem.java
@@ -108,15 +108,20 @@ public void hasReceivedBootNotification(String chargePointVendor, String chargeP
         assertThat(payload.getString("chargePointModel"), equalTo(chargePointModel));
     }
 
+    public void hasReceivedHeartbeat() {
+        assertThat(receivedMessage, is(not(nullValue())));
+        assertThat(getAction(), equalTo("Heartbeat"));
+    }
+
     public void hasReceivedDataTransferRequest() {
         assertThat(receivedMessage, is(not(nullValue())));
         assertThat(getAction(), equalTo("DataTransfer"));
     }
-
     public boolean hasReceivedAuthorizeRequest()
     {
         return receivedMessage != null && "Authorize".equals(getAction());
     }
+
     private JSONObject getCallPayload()
     {
         return (JSONObject)receivedMessage[3];
@@ -205,22 +210,24 @@ public void sendDataTransferRequest(String vendorId, String messageId, String da
         sendRequest("DataTransfer", String.format(payload, vendorId, messageId, data));
     }
 
-
-
     public enum AvailabilityType {
-        Inoperative, Operative;
+        Inoperative, Operative
     }
+
     public void sendChangeAvailability(int connectorId, AvailabilityType type)
     {
         String payload = "\"connectorId\":%d,\"type\":\"%s\"";
         sendRequest("ChangeAvailability", String.format(payload, connectorId, type));
     }
-
-
-
     public enum RegistrationStatus {
-        Accepted, Pending, Rejected;
+        Accepted, Pending, Rejected
     }
+
+    public void sendHeartbeatConfirmation() {
+        String payload = "\"currentTime\": \"%s\"";
+        sendConfirmation(String.format(payload, now()));
+    }
+
     public void sendBootConfirmation(RegistrationStatus status) {
         String payload = "\"currentTime\": \"%s\", \"interval\": %d, \"status\": \"%s\"";
         sendConfirmation(String.format(payload, now(), 300, status));
diff --git a/ocpp-test/src/main/java/eu/chargetime/ocpp/test/FakeChargePoint.java b/ocpp-test/src/main/java/eu/chargetime/ocpp/test/FakeChargePoint.java
@@ -101,6 +101,11 @@ public void sendAuthorizeRequest(String idToken) {
         }
     }
 
+    public void sendHeartbeatRequest() {
+        Request request = core.createHeartbeatRequest();
+        send(request);
+    }
+
     public void sendDataTransferRequest(String vendorId, String messageId, String data) {
         try {
             DataTransferRequest request = core.createDataTransferRequest(vendorId);
@@ -132,6 +137,10 @@ public void hasReceivedDataTransferConfirmation(String status) {
         assertThat(((DataTransferConfirmation)receivedConfirmation).getStatus(), equalTo(status));
     }
 
+    public void hasReceivedHeartbeatConfirmation() {
+        assertThat(receivedConfirmation, instanceOf(HeartbeatConfirmation.class));
+    }
+
     public void disconnect() {
         client.disconnect();
     }
diff --git a/ocpp-v1_6/src/it/groovy/core_features/Authorize.groovy b/ocpp-v1_6/src/it/groovy/core_features/Authorize.groovy
@@ -1,3 +1,5 @@
+package core_features
+
 import eu.chargetime.ocpp.test.FakeCentralSystem
 import eu.chargetime.ocpp.test.FakeChargePoint
 import spock.lang.Shared
@@ -27,7 +29,7 @@ class Authorize extends Specification
         ! centralSystem.hasReceivedAuthorizeRequest();
     }
 
-    def "Central system sends boot confirmation which charge point receives"() {
+    def "Charge point sends Authorize request and receives a response"() {
         def conditions = new PollingConditions(timeout: 1);
         when:
         chargePoint.sendAuthorizeRequest("test123");
@@ -46,7 +48,7 @@ class Authorize extends Specification
         }
     }
 
-    def "A authorize request isn't seen as a boot notification"() {
+    def "A Authorize request isn't seen as a Boot Notification"() {
         when:
         chargePoint.sendAuthorizeRequest("token");
 
diff --git a/ocpp-v1_6/src/it/groovy/core_features/BootNotification.groovy b/ocpp-v1_6/src/it/groovy/core_features/BootNotification.groovy
@@ -1,3 +1,5 @@
+package core_features
+
 import eu.chargetime.ocpp.test.FakeCentralSystem
 import eu.chargetime.ocpp.test.FakeChargePoint
 import spock.lang.*
@@ -21,7 +23,7 @@ class BootNotification extends Specification
         chargePoint.disconnect();
     }
     
-    def "Charge point sends boot notification and receives a response"() {
+    def "Charge point sends Boot Notification and receives a response"() {
         def conditions = new PollingConditions(timeout: 1)
         when:
         chargePoint.sendBootNotification("VendorX", "SingleSocketCharger");
diff --git a/ocpp-v1_6/src/it/groovy/core_features/ChangeAvailability.groovy b/ocpp-v1_6/src/it/groovy/core_features/ChangeAvailability.groovy
@@ -1,3 +1,5 @@
+package core_features
+
 import eu.chargetime.ocpp.test.FakeCentralSystem
 import eu.chargetime.ocpp.test.FakeChargePoint
 import spock.lang.*
diff --git a/ocpp-v1_6/src/it/groovy/core_features/ChangeConfiguration.groovy b/ocpp-v1_6/src/it/groovy/core_features/ChangeConfiguration.groovy
@@ -1,3 +1,5 @@
+package core_features
+
 import eu.chargetime.ocpp.test.FakeCentralSystem
 import eu.chargetime.ocpp.test.FakeChargePoint
 import spock.lang.Shared
diff --git a/ocpp-v1_6/src/it/groovy/core_features/ClearCache.groovy b/ocpp-v1_6/src/it/groovy/core_features/ClearCache.groovy
@@ -1,3 +1,5 @@
+package core_features
+
 import eu.chargetime.ocpp.test.FakeCentralSystem
 import eu.chargetime.ocpp.test.FakeChargePoint
 import spock.lang.Shared
diff --git a/ocpp-v1_6/src/it/groovy/core_features/DataTransfer.groovy b/ocpp-v1_6/src/it/groovy/core_features/DataTransfer.groovy
@@ -1,3 +1,5 @@
+package core_features
+
 import eu.chargetime.ocpp.test.FakeCentralSystem
 import eu.chargetime.ocpp.test.FakeChargePoint
 import spock.lang.Shared
diff --git a/ocpp-v1_6/src/it/groovy/core_features/GetConfiguration.groovy b/ocpp-v1_6/src/it/groovy/core_features/GetConfiguration.groovy
@@ -1,3 +1,5 @@
+package core_features
+
 import eu.chargetime.ocpp.test.FakeCentralSystem
 import eu.chargetime.ocpp.test.FakeChargePoint
 import spock.lang.Shared
diff --git a/ocpp-v1_6/src/it/groovy/core_features/Heartbeat.groovy b/ocpp-v1_6/src/it/groovy/core_features/Heartbeat.groovy
@@ -0,0 +1,48 @@
+package core_features
+
+import eu.chargetime.ocpp.test.FakeCentralSystem
+import eu.chargetime.ocpp.test.FakeChargePoint
+import spock.lang.Shared
+import spock.lang.Specification
+import spock.util.concurrent.PollingConditions;
+
+class Heartbeat extends Specification
+{
+    @Shared FakeCentralSystem centralSystem = FakeCentralSystem.getInstance();
+    @Shared FakeChargePoint chargePoint = new FakeChargePoint();
+
+    def setupSpec() {
+        // When a Central System is running
+        centralSystem.started();
+    }
+
+    def setup() {
+        chargePoint.connect();
+    }
+
+    def cleanup() {
+        chargePoint.disconnect();
+    }
+
+    def "Charge point sends Heartbeat and receives a response"() {
+        def conditions = new PollingConditions(timeout: 1);
+        when:
+        chargePoint.sendHeartbeatRequest();
+
+
+        then:
+        conditions.eventually {
+            centralSystem.hasReceivedHeartbeat();
+        }
+
+        when:
+            centralSystem.sendHeartbeatConfirmation();
+
+        then:
+        conditions.eventually {
+            chargePoint.hasReceivedHeartbeatConfirmation();
+        }
+
+    }
+
+}
diff --git a/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/feature/HeartbeatFeature.java b/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/feature/HeartbeatFeature.java
@@ -0,0 +1,53 @@
+package eu.chargetime.ocpp.feature;
+
+import eu.chargetime.ocpp.feature.profile.Profile;
+import eu.chargetime.ocpp.model.Confirmation;
+import eu.chargetime.ocpp.model.HeartbeatConfirmation;
+import eu.chargetime.ocpp.model.HeartbeatRequest;
+import eu.chargetime.ocpp.model.Request;
+
+/**
+ * ChargeTime.eu - Java-OCA-OCPP
+ *
+ * MIT License
+ *
+ * Copyright (C) 2016 Thomas Volden <tv@chargetime.eu>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+public class HeartbeatFeature extends Feature{
+    public HeartbeatFeature(Profile ownerProfile) {
+        super(ownerProfile);
+    }
+
+    @Override
+    public Class<? extends Request> getRequestType() {
+        return HeartbeatRequest.class;
+    }
+
+    @Override
+    public Class<? extends Confirmation> getConfirmationType() {
+        return HeartbeatConfirmation.class;
+    }
+
+    @Override
+    public String getAction() {
+        return "Heartbeat";
+    }
+}
diff --git a/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/feature/profile/CoreProfile.java b/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/feature/profile/CoreProfile.java
@@ -48,6 +48,7 @@ public CoreProfile(ClientCoreEventHandler handler) {
         features.add(new ChangeConfigurationFeature(this));
         features.add(new ClearCacheFeature(this));
         features.add(new DataTransferFeature(this));
+        features.add(new HeartbeatFeature(this));
     }
 
     public AuthorizeRequest createAuthorizeRequest(String idToken) throws PropertyConstraintException {
@@ -62,6 +63,10 @@ public DataTransferRequest createDataTransferRequest(String vendorId) {
         return new DataTransferRequest(vendorId);
     }
 
+    public HeartbeatRequest createHeartbeatRequest() {
+        return new HeartbeatRequest();
+    }
+
     @Override
     public Feature[] getFeatureList() {
         return features.toArray(new Feature[0]);
diff --git a/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/model/HeartbeatConfirmation.java b/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/model/HeartbeatConfirmation.java
@@ -0,0 +1,53 @@
+package eu.chargetime.ocpp.model;
+
+import java.text.SimpleDateFormat;
+import java.util.Calendar;
+import java.util.TimeZone;
+
+/**
+ * ChargeTime.eu - Java-OCA-OCPP
+ *
+ * MIT License
+ *
+ * Copyright (C) 2016 Thomas Volden <tv@chargetime.eu>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+public class HeartbeatConfirmation implements Confirmation {
+    private Calendar currentTime;
+
+    public Calendar objCurrentTime() {
+        return currentTime;
+    }
+
+    public String getCurrentTime() {
+        SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'");
+        formatter.setTimeZone(TimeZone.getTimeZone("GMT+00:00"));
+        return formatter.format(currentTime.getTime());
+    }
+
+    public void setCurrentTime(Calendar currentTime) {
+        this.currentTime = currentTime;
+    }
+
+    @Override
+    public boolean validate() {
+        return currentTime != null;
+    }
+}
diff --git a/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/model/HeartbeatRequest.java b/ocpp-v1_6/src/main/java/eu/chargetime/ocpp/model/HeartbeatRequest.java
@@ -0,0 +1,33 @@
+package eu.chargetime.ocpp.model;
+
+/**
+ * ChargeTime.eu - Java-OCA-OCPP
+ *
+ * MIT License
+ *
+ * Copyright (C) 2016 Thomas Volden <tv@chargetime.eu>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+public class HeartbeatRequest implements Request {
+    @Override
+    public boolean validate() {
+        return true;
+    }
+}
diff --git a/ocpp-v1_6/src/test/java/eu/chargetime/ocpp/feature/profile/test/CoreProfileTest.java b/ocpp-v1_6/src/test/java/eu/chargetime/ocpp/feature/profile/test/CoreProfileTest.java
@@ -1,5 +1,6 @@
 package eu.chargetime.ocpp.feature.profile.test;
 
+import core_features.Heartbeat;
 import eu.chargetime.ocpp.feature.*;
 import eu.chargetime.ocpp.feature.profile.ClientCoreEventHandler;
 import eu.chargetime.ocpp.feature.profile.CoreProfile;
@@ -77,6 +78,15 @@ public void createBootNotification_withVendorAndModel_returnsBootNotificationReq
         assertThat(result.getChargePointModel(), is(legalModel));
     }
 
+    @Test
+    public void createHeartbeat_returnsHeartbeatRequest() {
+        // When
+        Request result = core.createHeartbeatRequest();
+
+        // Then
+        assertThat(result, instanceOf(HeartbeatRequest.class));
+    }
+
     @Test
     public void getFeatureList_containsBootNotificationFeature() {
         // When
@@ -95,6 +105,15 @@ public void getFeatureList_containsAuthorizeFeature() {
         assertThat(findFeature(features, "Authorize"), is(instanceOf(AuthorizeFeature.class)));
     }
 
+    @Test
+    public void getFeatureList_containsHeartbeatFeature() {
+        // When
+        Feature[] features = core.getFeatureList();
+
+        // Then
+        assertThat(findFeature(features, "Heartbeat"), is(instanceOf(HeartbeatFeature.class)));
+    }
+
     @Test
     public void handleRequest_aChangeAvailabilityRequest_callsHandleChangeAvailabilityRequest() {
         // Given
diff --git a/ocpp-v1_6/src/test/java/eu/chargetime/ocpp/model/test/BootNotificationConfirmationTest.java b/ocpp-v1_6/src/test/java/eu/chargetime/ocpp/model/test/BootNotificationConfirmationTest.java
diff --git a/ocpp-v1_6/src/test/java/eu/chargetime/ocpp/model/test/HeartbeatConfirmationTest.java b/ocpp-v1_6/src/test/java/eu/chargetime/ocpp/model/test/HeartbeatConfirmationTest.java
diff --git a/ocpp-v1_6/src/test/java/eu/chargetime/ocpp/model/test/HeartbeatRequestTest.java b/ocpp-v1_6/src/test/java/eu/chargetime/ocpp/model/test/HeartbeatRequestTest.java

Original file line number	Diff line number	Diff line change
`@@ -108,15 +108,20 @@ public void hasReceivedBootNotification(String chargePointVendor, String chargeP`
`108`	`108`	`assertThat(payload.getString("chargePointModel"), equalTo(chargePointModel));`
`109`	`109`	`}`
`110`	`110`
	`111`	`+ public void hasReceivedHeartbeat() {`
	`112`	`+ assertThat(receivedMessage, is(not(nullValue())));`
	`113`	`+ assertThat(getAction(), equalTo("Heartbeat"));`
	`114`	`+ }`
	`115`	`+`
`111`	`116`	`public void hasReceivedDataTransferRequest() {`
`112`	`117`	`assertThat(receivedMessage, is(not(nullValue())));`
`113`	`118`	`assertThat(getAction(), equalTo("DataTransfer"));`
`114`	`119`	`}`
`115`		`-`
`116`	`120`	`public boolean hasReceivedAuthorizeRequest()`
`117`	`121`	`{`
`118`	`122`	`return receivedMessage != null && "Authorize".equals(getAction());`
`119`	`123`	`}`
	`124`	`+`
`120`	`125`	`private JSONObject getCallPayload()`
`121`	`126`	`{`
`122`	`127`	`return (JSONObject)receivedMessage[3];`
`@@ -205,22 +210,24 @@ public void sendDataTransferRequest(String vendorId, String messageId, String da`
`205`	`210`	`sendRequest("DataTransfer", String.format(payload, vendorId, messageId, data));`
`206`	`211`	`}`
`207`	`212`
`208`		`-`
`209`		`-`
`210`	`213`	`public enum AvailabilityType {`
`211`		`- Inoperative, Operative;`
	`214`	`+ Inoperative, Operative`
`212`	`215`	`}`
	`216`	`+`
`213`	`217`	`public void sendChangeAvailability(int connectorId, AvailabilityType type)`
`214`	`218`	`{`
`215`	`219`	`String payload = "\"connectorId\":%d,\"type\":\"%s\"";`
`216`	`220`	`sendRequest("ChangeAvailability", String.format(payload, connectorId, type));`
`217`	`221`	`}`
`218`		`-`
`219`		`-`
`220`		`-`
`221`	`222`	`public enum RegistrationStatus {`
`222`		`- Accepted, Pending, Rejected;`
	`223`	`+ Accepted, Pending, Rejected`
`223`	`224`	`}`
	`225`	`+`
	`226`	`+ public void sendHeartbeatConfirmation() {`
	`227`	`+ String payload = "\"currentTime\": \"%s\"";`
	`228`	`+ sendConfirmation(String.format(payload, now()));`
	`229`	`+ }`
	`230`	`+`
`224`	`231`	`public void sendBootConfirmation(RegistrationStatus status) {`
`225`	`232`	`String payload = "\"currentTime\": \"%s\", \"interval\": %d, \"status\": \"%s\"";`
`226`	`233`	`sendConfirmation(String.format(payload, now(), 300, status));`
Original file line number	Diff line number	Diff line change
`@@ -101,6 +101,11 @@ public void sendAuthorizeRequest(String idToken) {`
`101`	`101`	`}`
`102`	`102`	`}`
`103`	`103`
	`104`	`+ public void sendHeartbeatRequest() {`
	`105`	`+ Request request = core.createHeartbeatRequest();`
	`106`	`+ send(request);`
	`107`	`+ }`
	`108`	`+`
`104`	`109`	`public void sendDataTransferRequest(String vendorId, String messageId, String data) {`
`105`	`110`	`try {`
`106`	`111`	`DataTransferRequest request = core.createDataTransferRequest(vendorId);`
`@@ -132,6 +137,10 @@ public void hasReceivedDataTransferConfirmation(String status) {`
`132`	`137`	`assertThat(((DataTransferConfirmation)receivedConfirmation).getStatus(), equalTo(status));`
`133`	`138`	`}`
`134`	`139`
	`140`	`+ public void hasReceivedHeartbeatConfirmation() {`
	`141`	`+ assertThat(receivedConfirmation, instanceOf(HeartbeatConfirmation.class));`
	`142`	`+ }`
	`143`	`+`
`135`	`144`	`public void disconnect() {`
`136`	`145`	`client.disconnect();`
`137`	`146`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+package core_features`
	`2`	`+`
`1`	`3`	`import eu.chargetime.ocpp.test.FakeCentralSystem`
`2`	`4`	`import eu.chargetime.ocpp.test.FakeChargePoint`
`3`	`5`	`import spock.lang.Shared`
`@@ -27,7 +29,7 @@ class Authorize extends Specification`
`27`	`29`	`! centralSystem.hasReceivedAuthorizeRequest();`
`28`	`30`	`}`
`29`	`31`
`30`		`- def "Central system sends boot confirmation which charge point receives"() {`
	`32`	`+ def "Charge point sends Authorize request and receives a response"() {`
`31`	`33`	`def conditions = new PollingConditions(timeout: 1);`
`32`	`34`	`when:`
`33`	`35`	`chargePoint.sendAuthorizeRequest("test123");`
`@@ -46,7 +48,7 @@ class Authorize extends Specification`
`46`	`48`	`}`
`47`	`49`	`}`
`48`	`50`
`49`		`- def "A authorize request isn't seen as a boot notification"() {`
	`51`	`+ def "A Authorize request isn't seen as a Boot Notification"() {`
`50`	`52`	`when:`
`51`	`53`	`chargePoint.sendAuthorizeRequest("token");`
`52`	`54`