Change order of CM Handle Reference lookup depending on special character

- implemented new algorithm using validator to rule out standard id / prefer alternate id
- moved validator imp to cps-service (not in RI) TBC!!!
- changed order of characters tested in validator to fail fast (on '=')
- added Boolean variation validator method to reduce overhead and prevent logic based on exceptions
- improved integration test to cover all scenarios
- add performance test for alternate id look up (report only)
- ensured all performance test use alternate ids it '='
- added small groovy tests to restore cps-ri code coverage to 0.31

Issue-ID: CPS-2605
Change-Id: Id9c22bb69904b7f5d376b7f8319332428435333e
Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
Signed-off-by: seanbeirne <sean.beirne@est.tech>

2 files changed, 92 insertions, 3 deletions

diff --git a/cps-service/src/main/java/org/onap/cps/utils/CpsValidator.java b/cps-service/src/main/java/org/onap/cps/utils/CpsValidator.java
index 93f51ee58d..2244ea729b 100644
--- a/cps-service/src/main/java/org/onap/cps/utils/CpsValidator.java
+++ b/cps-service/src/main/java/org/onap/cps/utils/CpsValidator.java
@@ -1,6 +1,6 @@
 /*
  *  ============LICENSE_START=======================================================
- *  Copyright (C) 2022-2023 Nordix Foundation
+ *  Copyright (C) 2022-2025 Nordix Foundation
  *  ================================================================================
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -20,21 +20,32 @@
 
 package org.onap.cps.utils;
 
+import org.onap.cps.api.exceptions.DataValidationException;
 import org.onap.cps.api.parameters.PaginationOption;
 
 public interface CpsValidator {
 
     /**
+     * Validate characters in name within cps.
+     *
+     * @param name name to be validated
+     * @return true if name is valid
+     */
+    boolean isValidName(final String name);
+
+    /**
      * Validate characters in names within cps.
      *
-     * @param names names of data to be validated
+     * @param names names to be validated
+     * @throws DataValidationException for any name that is not valid.
      */
     void validateNameCharacters(final String... names);
 
     /**
      * Validate characters in names within cps.
      *
-     * @param names names of data to be validated
+     * @param names names  to be validated
+     * @throws DataValidationException for any name that is not valid.
      */
     void validateNameCharacters(final Iterable<String> names);
 
diff --git a/cps-service/src/main/java/org/onap/cps/utils/CpsValidatorImpl.java b/cps-service/src/main/java/org/onap/cps/utils/CpsValidatorImpl.java
new file mode 100644
index 0000000000..e1c81bfaf5
--- /dev/null
+++ b/cps-service/src/main/java/org/onap/cps/utils/CpsValidatorImpl.java
@@ -0,0 +1,78 @@
+/*
+ *  ============LICENSE_START=======================================================
+ *  Copyright (C) 2022-2025 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.cps.utils;
+
+import com.google.common.collect.Lists;
+import java.util.Arrays;
+import java.util.Collection;
+import lombok.RequiredArgsConstructor;
+import org.onap.cps.api.exceptions.DataValidationException;
+import org.onap.cps.api.parameters.PaginationOption;
+import org.springframework.stereotype.Component;
+
+@Component
+@RequiredArgsConstructor
+public class CpsValidatorImpl implements CpsValidator {
+
+    private static final char[] UNSUPPORTED_NAME_CHARACTERS = "=!\" #$%&'()*+,./\\:;<>?@[]^`{|}~".toCharArray();
+
+    @Override
+    public boolean isValidName(final String name) {
+        final Collection<Character> charactersOfName = Lists.charactersOf(name);
+        for (final char unsupportedCharacter : UNSUPPORTED_NAME_CHARACTERS) {
+            if (charactersOfName.contains(unsupportedCharacter)) {
+                return false;
+            }
+        }
+        return true;
+    }
+
+    @Override
+    public void validateNameCharacters(final String... names) {
+        validateNameCharacters(Arrays.asList(names));
+    }
+
+    @Override
+    public void validateNameCharacters(final Iterable<String> names) {
+        for (final String name : names) {
+            final Collection<Character> charactersOfName = Lists.charactersOf(name);
+            for (final char unsupportedCharacter : UNSUPPORTED_NAME_CHARACTERS) {
+                if (charactersOfName.contains(unsupportedCharacter)) {
+                    throw new DataValidationException("Name or ID Validation Error.",
+                        name + " invalid token encountered at position "
+                            + (name.indexOf(unsupportedCharacter) + 1));
+                }
+            }
+        }
+    }
+
+    @Override
+    public void validatePaginationOption(final PaginationOption paginationOption) {
+        if (PaginationOption.NO_PAGINATION == paginationOption) {
+            return;
+        }
+
+        if (!paginationOption.isValidPaginationOption()) {
+            throw new DataValidationException("Pagination validation error.",
+                    "Invalid page index or size");
+        }
+    }
+}