Add PfReference Timestamp key in policy-models-base to support timestamp

property

Issue-ID: POLICY-3011
Signed-off-by: zrrmmua <ramesh.murugan.iyer@est.tech>
Change-Id: I7a9db3a4fb0345e0979952e5c086523cc1d960f9

2 files changed, 375 insertions, 0 deletions

diff --git a/models-base/src/main/java/org/onap/policy/models/base/PfReferenceTimestampKey.java b/models-base/src/main/java/org/onap/policy/models/base/PfReferenceTimestampKey.java
new file mode 100644
index 000000000..5cb639ed5
--- /dev/null
+++ b/models-base/src/main/java/org/onap/policy/models/base/PfReferenceTimestampKey.java
@@ -0,0 +1,222 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2021 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.models.base;
+
+import java.time.Instant;
+import javax.persistence.Column;
+import javax.persistence.Embeddable;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NonNull;
+import lombok.ToString;
+import org.onap.policy.common.parameters.annotations.NotNull;
+import org.onap.policy.common.utils.validation.Assertions;
+
+/**
+ * This class is an extension of PfReferenceKey. It has similar behaviour as of PfReferenceKey with an
+ * additional option to have timestamp as a parameter.
+ *
+ */
+@Embeddable
+@Data
+@EqualsAndHashCode
+@ToString(callSuper = true)
+public class PfReferenceTimestampKey extends PfReferenceKey {
+    private static final String TIMESTAMP_TOKEN = "timeStamp";
+    private static final Instant DEFAULT_TIMESTAMP = Instant.EPOCH;
+
+    @Column(name = TIMESTAMP_TOKEN)
+    @NotNull
+    private Instant timeStamp;
+
+
+    /**
+     * The default constructor creates a null reference timestamp key.
+     */
+    public PfReferenceTimestampKey() {
+        super();
+        this.timeStamp = DEFAULT_TIMESTAMP;
+    }
+
+    /**
+     * The Copy Constructor creates a key by copying another key.
+     *
+     * @param referenceKey
+     *        the reference key to copy from
+     */
+    public PfReferenceTimestampKey(final PfReferenceTimestampKey referenceKey) {
+        super(referenceKey);
+        this.timeStamp = referenceKey.getTimeStamp();
+    }
+
+    /**
+     * Constructor to create a null reference key for the specified parent concept key.
+     *
+     * @param pfConceptKey
+     *        the parent concept key of this reference key
+     */
+    public PfReferenceTimestampKey(final PfConceptKey pfConceptKey) {
+        super(pfConceptKey);
+        this.timeStamp = DEFAULT_TIMESTAMP;
+    }
+
+    /**
+     * Constructor to create a reference timestamp key for the given parent concept key with the given local name.
+     *
+     * @param pfConceptKey
+     *        the parent concept key of this reference key
+     * @param localName
+     *        the local name of this reference key
+     * @param timeStamp
+     *        the timestamp for this reference key
+     */
+    public PfReferenceTimestampKey(final PfConceptKey pfConceptKey, final String localName, final Instant timeStamp) {
+        super(pfConceptKey, localName);
+        this.timeStamp = timeStamp;
+    }
+
+    /**
+     * Constructor to create a reference timestamp key for the given parent reference key with the given local name.
+     *
+     * @param parentReferenceKey
+     *        the parent reference key of this reference key
+     * @param localName
+     *        the local name of this reference key
+     * @param timeStamp
+     *        the timestamp for this reference key
+     */
+    public PfReferenceTimestampKey(final PfReferenceKey parentReferenceKey, final String localName,
+                                   final Instant timeStamp) {
+        super(parentReferenceKey, localName);
+        this.timeStamp = timeStamp;
+    }
+
+    /**
+     * Constructor to create a reference timestamp key for the given parent reference key (specified by the parent
+     * reference key's concept key and local name) with the given local name.
+     *
+     * @param pfConceptKey
+     *        the concept key of the parent reference key of this reference key
+     * @param parentLocalName
+     *        the local name of the parent reference key of this reference key
+     * @param localName
+     *        the local name of this reference key
+     * @param timeStamp
+     *        the timestamp for this reference key
+     */
+    public PfReferenceTimestampKey(final PfConceptKey pfConceptKey, final String parentLocalName,
+                                   final String localName, final Instant timeStamp) {
+        super(pfConceptKey, parentLocalName, localName);
+        this.timeStamp = timeStamp;
+    }
+
+    /**
+     * Constructor to create a reference timestamp key for the given parent concept key (specified by the
+     * parent concept key's name and version) with the given local name.
+     *
+     * @param parentKeyName
+     *        the name of the parent concept key of this reference key
+     * @param parentKeyVersion
+     *        the version of the parent concept key of this reference key
+     * @param localName
+     *        the local name of this reference key
+     * @param timeStamp
+     *        the timestamp for this reference key
+     */
+    public PfReferenceTimestampKey(final String parentKeyName, final String parentKeyVersion, final String localName,
+                                   final Instant timeStamp) {
+        super(parentKeyName, parentKeyVersion, NULL_KEY_NAME, localName);
+        this.timeStamp = timeStamp;
+    }
+
+    /**
+     * Constructor to create a reference timestamp key for the given parent key (specified by the parent key's name,
+     * version and local name) with the given local name.
+     *
+     * @param parentKeyName
+     *        the parent key name of this reference key
+     * @param parentKeyVersion
+     *        the parent key version of this reference key
+     * @param parentLocalName
+     *        the parent local name of this reference key
+     * @param localName
+     *        the local name of this reference key
+     * @param timeStamp
+     *        the timestamp for this reference key
+     */
+    public PfReferenceTimestampKey(final String parentKeyName, final String parentKeyVersion,
+                                   final String parentLocalName, final String localName, final Instant timeStamp) {
+        super(parentKeyName, parentKeyVersion, parentLocalName, localName);
+        this.timeStamp = timeStamp;
+    }
+
+
+    /**
+     * Constructor to create a key using the key and version from the specified key ID.
+     *
+     * @param id the key ID in a format that respects the KEY_ID_REGEXP
+     */
+    public PfReferenceTimestampKey(final String id) {
+        super(id.substring(0, id.lastIndexOf(':')));
+        this.timeStamp = Instant.ofEpochSecond(Long.parseLong(id.substring(id.lastIndexOf(':') + 1)));
+    }
+
+
+    /**
+     * Get a null reference timestamp key.
+     *
+     * @return a null reference key
+     */
+    public static PfReferenceTimestampKey getNullKey() {
+        return new PfReferenceTimestampKey(PfKey.NULL_KEY_NAME, PfKey.NULL_KEY_VERSION, PfKey.NULL_KEY_NAME,
+            PfKey.NULL_KEY_NAME, DEFAULT_TIMESTAMP);
+    }
+
+
+    @Override
+    public PfReferenceTimestampKey getKey() {
+        return this;
+    }
+
+    @Override
+    public String getId() {
+        return super.getId() + ':' + getTimeStamp().getEpochSecond();
+    }
+
+    @Override
+    public boolean isNullKey() {
+        return super.isNullKey() && getTimeStamp().getEpochSecond() == 0;
+    }
+
+    @Override
+    public boolean isNewerThan(@NonNull PfKey otherKey) {
+        Assertions.instanceOf(otherKey, PfReferenceTimestampKey.class);
+        final PfReferenceTimestampKey otherConceptKey = (PfReferenceTimestampKey) otherKey;
+
+        if (this.equals(otherConceptKey)) {
+            return false;
+        }
+        if (!getTimeStamp().equals(otherConceptKey.timeStamp)) {
+            return timeStamp.isAfter(otherConceptKey.timeStamp);
+        }
+        return super.isNewerThan(otherKey);
+    }
+}
diff --git a/models-base/src/test/java/org/onap/policy/models/base/PfReferenceTimestampKeyTest.java b/models-base/src/test/java/org/onap/policy/models/base/PfReferenceTimestampKeyTest.java
new file mode 100644
index 000000000..b6eae6745
--- /dev/null
+++ b/models-base/src/test/java/org/onap/policy/models/base/PfReferenceTimestampKeyTest.java
@@ -0,0 +1,153 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2021 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.models.base;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNotEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+
+import java.time.Instant;
+import org.junit.Test;
+
+public class PfReferenceTimestampKeyTest {
+
+    private static final String PARENT_LOCAL_NAME = "ParentLocalName";
+    private static final String LOCAL_NAME = "LocalName";
+    private static final String VERSION002 = "0.0.2";
+    private static final String VERSION001 = "0.0.1";
+    private static final long timeStamp = 1613152081L;
+    private static final Instant DEFAULT_TIMESTAMP = Instant.EPOCH;
+
+    @Test
+    public void testPfReferenceTimestampKeyConstruct() {
+        assertThat(new PfReferenceTimestampKey().getLocalName()).isEqualTo(PfKey.NULL_KEY_NAME);
+        assertEquals(PfKey.NULL_KEY_NAME, new PfReferenceTimestampKey(new PfConceptKey()).getParentKeyName());
+        assertNotNull(new PfReferenceTimestampKey(new PfReferenceTimestampKey()).getTimeStamp());
+
+        assertEquals(LOCAL_NAME, new PfReferenceTimestampKey(new PfReferenceKey(), LOCAL_NAME,
+            Instant.ofEpochSecond(timeStamp)).getLocalName());
+        assertEquals(Instant.ofEpochSecond(timeStamp), new PfReferenceTimestampKey(new PfConceptKey(),
+            PARENT_LOCAL_NAME, LOCAL_NAME, Instant.ofEpochSecond(timeStamp)).getTimeStamp());
+
+        assertThat(new PfReferenceTimestampKey("ParentKeyName", VERSION001, PARENT_LOCAL_NAME,
+            LOCAL_NAME, Instant.ofEpochSecond(timeStamp))).isInstanceOf(PfReferenceTimestampKey.class);
+
+        assertThat(new PfReferenceTimestampKey("ParentKeyName", VERSION001, LOCAL_NAME,
+            Instant.ofEpochSecond(timeStamp)).getParentLocalName()).isEqualTo(PfKey.NULL_KEY_NAME);
+
+        assertEquals(PfReferenceTimestampKey.getNullKey().getKey(), PfReferenceTimestampKey.getNullKey());
+        assertEquals("NULL:0.0.0:NULL:NULL:" + Instant.EPOCH.getEpochSecond(),
+            PfReferenceTimestampKey.getNullKey().getId());
+
+        assertThatThrownBy(() -> new PfReferenceTimestampKey(new PfConceptKey(), null, null))
+            .hasMessage("parameter \"localName\" is null");
+
+        String id = "NULL:0.0.0:NULL:NULL:" + timeStamp;
+        assertThat(new PfReferenceTimestampKey(id).getTimeStamp().getEpochSecond()).isEqualTo(timeStamp);
+
+    }
+
+    @Test
+    public void testPfReferenceTimestampKey() {
+        PfReferenceTimestampKey testReferenceKey = new PfReferenceTimestampKey();
+        testReferenceKey.setParentConceptKey(new PfConceptKey("PN", VERSION001));
+        assertEquals("PN:0.0.1", testReferenceKey.getParentConceptKey().getId());
+
+        assertEquals(1, testReferenceKey.getKeys().size());
+        assertFalse(testReferenceKey.isNullKey());
+
+        testReferenceKey.setParentReferenceKey(new PfReferenceKey("PN", VERSION001,
+            "LN"));
+        assertEquals("PN:0.0.1:NULL:LN", testReferenceKey.getParentReferenceKey().getId());
+
+        testReferenceKey.setParentKeyName("PKN");
+        assertEquals("PKN", testReferenceKey.getParentKeyName());
+
+        testReferenceKey.setParentKeyVersion(VERSION001);
+        assertEquals(VERSION001, testReferenceKey.getParentKeyVersion());
+
+        testReferenceKey.setParentLocalName(PARENT_LOCAL_NAME);
+        assertEquals(PARENT_LOCAL_NAME, testReferenceKey.getParentLocalName());
+
+        testReferenceKey.setLocalName("LN");
+        assertEquals("LN", testReferenceKey.getLocalName());
+
+        testReferenceKey.setTimeStamp(DEFAULT_TIMESTAMP);
+        assertEquals(DEFAULT_TIMESTAMP, testReferenceKey.getTimeStamp());
+
+
+        assertThatThrownBy(() -> testReferenceKey.isCompatible(null))
+            .hasMessageMatching("^otherKey is marked .*on.*ull but is null$");
+
+        assertFalse(testReferenceKey.isCompatible(PfConceptKey.getNullKey()));
+        assertFalse(testReferenceKey.isCompatible(PfReferenceKey.getNullKey()));
+        assertTrue(testReferenceKey.isCompatible(testReferenceKey));
+
+        assertTrue(testReferenceKey.validate("").isValid());
+
+        testReferenceKey.clean();
+
+        PfReferenceTimestampKey clonedReferenceKey = new PfReferenceTimestampKey(testReferenceKey);
+
+        assertEquals("PfReferenceTimestampKey(super=PfReferenceKey(parentKeyName=PKN, parentKeyVersion=0.0.1, "
+                + "parentLocalName=ParentLocalName, localName=LN), timeStamp=" + Instant.EPOCH + ")",
+            clonedReferenceKey.toString());
+
+        assertNotEquals(0, testReferenceKey.hashCode());
+
+        assertEquals(testReferenceKey, clonedReferenceKey);
+        assertNotEquals(testReferenceKey, new PfReferenceTimestampKey("PKN", VERSION001,
+            "PLN", "LN", Instant.ofEpochSecond(timeStamp)));
+        testReferenceKey.setTimeStamp(Instant.ofEpochSecond(timeStamp));
+        assertEquals(testReferenceKey, new PfReferenceTimestampKey("PKN", VERSION001,
+            PARENT_LOCAL_NAME, "LN", Instant.ofEpochSecond(timeStamp)));
+
+        assertNotEquals(0, testReferenceKey.compareTo(new PfConceptKey()));
+        assertNotEquals(0, testReferenceKey.compareTo(new PfReferenceTimestampKey("PKN",
+            VERSION002, "PLN", "LN", Instant.ofEpochSecond(timeStamp))));
+        assertEquals(0, testReferenceKey.compareTo(new PfReferenceTimestampKey("PKN",
+            VERSION001, PARENT_LOCAL_NAME, "LN", Instant.ofEpochSecond(timeStamp))));
+
+        assertThatThrownBy(() -> new PfReferenceTimestampKey((PfReferenceTimestampKey) null))
+            .isInstanceOf(NullPointerException.class);
+
+        assertEquals(testReferenceKey, new PfReferenceTimestampKey(testReferenceKey));
+
+    }
+
+    @Test
+    public void testNewerKey() {
+        PfReferenceTimestampKey key1 = new PfReferenceTimestampKey("ParentKeyName", VERSION001,
+            PARENT_LOCAL_NAME, LOCAL_NAME, Instant.ofEpochSecond(timeStamp));
+        PfReferenceTimestampKey key2 = new PfReferenceTimestampKey(key1);
+        assertFalse(key2.isNewerThan(key1));
+        assertThatThrownBy(() -> key1.isNewerThan((PfKey) null)).isInstanceOf(NullPointerException.class)
+            .hasMessageMatching("^otherKey is marked .*on.*ull but is null$");
+
+        key2.setTimeStamp(Instant.ofEpochSecond(timeStamp).plusSeconds(80));
+        assertTrue(key2.isNewerThan(key1));
+    }
+
+}