diff options
Diffstat (limited to 'framework/src/main/java')
11 files changed, 359 insertions, 5 deletions
diff --git a/framework/src/main/java/org/onap/cli/fw/cmd/OnapCommandProfileAutoDiscoverRegister.java b/framework/src/main/java/org/onap/cli/fw/cmd/OnapCommandProfileAutoDiscoverRegister.java new file mode 100644 index 00000000..d2609c2b --- /dev/null +++ b/framework/src/main/java/org/onap/cli/fw/cmd/OnapCommandProfileAutoDiscoverRegister.java @@ -0,0 +1,50 @@ +/* + * Copyright 2020 Huawei Technologies Co., Ltd. + * + * 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. + */ + +package org.onap.cli.fw.cmd; + +public interface OnapCommandProfileAutoDiscoverRegister { + + /** + * When profile needs to add the capability where there are multiple operations + * are available and profile wants to translate those operations in to OCS YAML. + * + * Example, swagger HTTP methods to OCS YAML (command) + * + * Steps: + * 1. implement this interface to create OCS YAML for each of the operations + * and store them under <OPEN_CLI_HOME>/open-cli-schema. + * NOTE: Make sure the YAML created are proper and valid, otherwise invalid + * YAML will be ignored by OCOMP registrar. + * + * 2. Invoke this interface when profile is instantiated + * @OnapCommandSchema(type = 'profile name') + public class OnapSampleProfile implements OnapCommandProfileAutoDiscoverRegister { + public OnapHttpCommand() { + super.addDefaultSchemas(OnapCommandHttpConstants.DEFAULT_PARAMETER_HTTP_FILE_NAME); + this.discover(); + } + + public void discover() { + + } + } + * + * 3. Run command schema-refresh to get auto registered into registrar. + * + */ + void discover(); +} diff --git a/framework/src/main/java/org/onap/cli/fw/cmd/profile/OnapProfileDeleteCommand.java b/framework/src/main/java/org/onap/cli/fw/cmd/profile/OnapProfileDeleteCommand.java new file mode 100644 index 00000000..393d199b --- /dev/null +++ b/framework/src/main/java/org/onap/cli/fw/cmd/profile/OnapProfileDeleteCommand.java @@ -0,0 +1,37 @@ +/* + * Copyright 2018 Huawei Technologies Co., Ltd. + * + * 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. + */ + +package org.onap.cli.fw.cmd.profile; + +import org.onap.cli.fw.cmd.OnapCommand; +import org.onap.cli.fw.error.OnapCommandException; +import org.onap.cli.fw.schema.OnapCommandSchema; +import org.onap.cli.fw.store.OnapCommandProfileStore; + +/** + * Refresh external schema. + * + */ +@OnapCommandSchema(schema = "profile-delete.yaml") +public class OnapProfileDeleteCommand extends OnapCommand { + + @Override + protected void run() throws OnapCommandException { + String profile = getParametersMap().get("profile").getValue().toString(); + + OnapCommandProfileStore.getInstance().removeProfile(profile); + } +}
\ No newline at end of file diff --git a/framework/src/main/java/org/onap/cli/fw/cmd/profile/OnapProfileListCommand.java b/framework/src/main/java/org/onap/cli/fw/cmd/profile/OnapProfileListCommand.java new file mode 100644 index 00000000..7e70facc --- /dev/null +++ b/framework/src/main/java/org/onap/cli/fw/cmd/profile/OnapProfileListCommand.java @@ -0,0 +1,39 @@ +/* + * Copyright 2018 Huawei Technologies Co., Ltd. + * + * 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. + */ + +package org.onap.cli.fw.cmd.profile; + +import org.onap.cli.fw.cmd.OnapCommand; +import org.onap.cli.fw.error.OnapCommandException; +import org.onap.cli.fw.schema.OnapCommandSchema; +import org.onap.cli.fw.store.OnapCommandProfileStore; + +/** + * Refresh external schema. + * + */ +@OnapCommandSchema(schema = "profile-list.yaml") +public class OnapProfileListCommand extends OnapCommand { + + @Override + protected void run() throws OnapCommandException { + + for (String profile : OnapCommandProfileStore.getInstance().getProfiles()) { + this.getResult().getRecordsMap().get("profile").getValues().add(profile); + } + } + +} diff --git a/framework/src/main/java/org/onap/cli/fw/cmd/profile/OnapProfileSetCommand.java b/framework/src/main/java/org/onap/cli/fw/cmd/profile/OnapProfileSetCommand.java new file mode 100644 index 00000000..fa83ace3 --- /dev/null +++ b/framework/src/main/java/org/onap/cli/fw/cmd/profile/OnapProfileSetCommand.java @@ -0,0 +1,85 @@ +/* + * Copyright 2018 Huawei Technologies Co., Ltd. + * + * 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. + */ + +package org.onap.cli.fw.cmd.profile; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.onap.cli.fw.cmd.OnapCommand; +import org.onap.cli.fw.error.OnapCommandException; +import org.onap.cli.fw.error.OnapCommandProfileNotFound; +import org.onap.cli.fw.input.cache.OnapCommandParamEntity; +import org.onap.cli.fw.schema.OnapCommandSchema; +import org.onap.cli.fw.store.OnapCommandProfileStore; + +/** + * Refresh external schema. + * + */ +@OnapCommandSchema(schema = "profile-set.yaml") +public class OnapProfileSetCommand extends OnapCommand { + + @Override + protected void run() throws OnapCommandException { + String product = getParametersMap().get("product").getValue().toString(); + String profile = getParametersMap().get("profile").getValue().toString(); + String service = getParametersMap().get("service").getValue().toString(); + String command = getParametersMap().get("command").getValue().toString(); + + Map<String, String> params = (Map<String, String>)getParametersMap().get("parameter").getValue(); + + OnapCommandProfileStore cache = OnapCommandProfileStore.getInstance(); + + String prefix = ""; + if (service.length() > 0) { + prefix += service + ":"; + } + if (command.length() > 0) { + prefix += command + ":"; + } + + Map<String, OnapCommandParamEntity> map = new HashMap<>(); + + try { + for (OnapCommandParamEntity paramsExisting : cache.getInstance().loadParamFromCache(profile)) { + map.put(paramsExisting.getProduct() + ":" + paramsExisting.getName(), paramsExisting); + } + } catch (OnapCommandProfileNotFound e) { + //ignore amd proceed to create + } + + for (Map.Entry<String, String> entry: params.entrySet()) { + String name = prefix + entry.getKey(); + OnapCommandParamEntity entity = new OnapCommandParamEntity(); + entity.setProduct(product); + entity.setName(name); + entity.setValue(entry.getValue()); + + map.put(entity.getProduct() + ":" + entity.getName(), entity); + } + + List<OnapCommandParamEntity> es = new ArrayList<>(); + for (OnapCommandParamEntity e : map.values()) { + es.add(e); + } + + cache.persistProfile( es, profile); + } + +}
\ No newline at end of file diff --git a/framework/src/main/java/org/onap/cli/fw/cmd/profile/OnapProfileShowCommand.java b/framework/src/main/java/org/onap/cli/fw/cmd/profile/OnapProfileShowCommand.java new file mode 100644 index 00000000..b3d20217 --- /dev/null +++ b/framework/src/main/java/org/onap/cli/fw/cmd/profile/OnapProfileShowCommand.java @@ -0,0 +1,63 @@ +/* + * Copyright 2018 Huawei Technologies Co., Ltd. + * + * 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. + */ + +package org.onap.cli.fw.cmd.profile; + +import org.onap.cli.fw.cmd.OnapCommand; +import org.onap.cli.fw.conf.OnapCommandConstants; +import org.onap.cli.fw.error.OnapCommandException; +import org.onap.cli.fw.input.cache.OnapCommandParamEntity; +import org.onap.cli.fw.schema.OnapCommandSchema; +import org.onap.cli.fw.store.OnapCommandProfileStore; + +/** + * Refresh external schema. + * + */ +@OnapCommandSchema(schema = "profile-show.yaml") +public class OnapProfileShowCommand extends OnapCommand { + + @Override + protected void run() throws OnapCommandException { + String profile = getParametersMap().get("profile").getValue().toString(); + + for (OnapCommandParamEntity param : OnapCommandProfileStore.getInstance().loadParamFromCache(profile)) { + + String product = param.getProduct(); + if (product.equals(OnapCommandConstants.OCLIP_GLOBAL_PROFILE)) { + //profile param is global + product = "*"; + } + this.getResult().getRecordsMap().get("product").getValues().add(product); + + String []name = param.getName().split(":"); //service:command:param-name + String paramName = name[name.length-1]; //always last entry is param name + this.getResult().getRecordsMap().get("parameter").getValues().add(paramName); + this.getResult().getRecordsMap().get("value").getValues().add(param.getValue()); + String service = "*"; + String command = "*"; + if (name.length == 3) { + service = name[0]; + command = name[1]; + } else if (name.length == 2) { + service = name[0]; + } + this.getResult().getRecordsMap().get("service").getValues().add(service); + this.getResult().getRecordsMap().get("command").getValues().add(command); + } + } + +}
\ No newline at end of file diff --git a/framework/src/main/java/org/onap/cli/fw/cmd/profile/OnapProfileUnsetCommand.java b/framework/src/main/java/org/onap/cli/fw/cmd/profile/OnapProfileUnsetCommand.java new file mode 100644 index 00000000..06474ec2 --- /dev/null +++ b/framework/src/main/java/org/onap/cli/fw/cmd/profile/OnapProfileUnsetCommand.java @@ -0,0 +1,77 @@ +/* + * Copyright 2018 Huawei Technologies Co., Ltd. + * + * 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. + */ + +package org.onap.cli.fw.cmd.profile; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.onap.cli.fw.cmd.OnapCommand; +import org.onap.cli.fw.error.OnapCommandException; +import org.onap.cli.fw.input.cache.OnapCommandParamEntity; +import org.onap.cli.fw.schema.OnapCommandSchema; +import org.onap.cli.fw.store.OnapCommandProfileStore; + +/** + * Refresh external schema. + * + */ +@OnapCommandSchema(schema = "profile-unset.yaml") +public class OnapProfileUnsetCommand extends OnapCommand { + + @Override + protected void run() throws OnapCommandException { + //mrkanag add feature to remove the profile at product or service or command level + String product = getParametersMap().get("product").getValue().toString(); + String profile = getParametersMap().get("profile").getValue().toString(); + String service = getParametersMap().get("service").getValue().toString(); + String command = getParametersMap().get("command").getValue().toString(); + + List<String> params = (List<String>)getParametersMap().get("parameter").getValue(); + + OnapCommandProfileStore cache = OnapCommandProfileStore.getInstance(); + + String prefix = ""; + if (service.length() > 0) { + prefix += service + ":"; + } + if (command.length() > 0) { + prefix += command + ":"; + } + + Map<String, OnapCommandParamEntity> map = new HashMap<>(); + + for (OnapCommandParamEntity paramsExisting : cache.getInstance().loadParamFromCache(profile)) { + map.put(paramsExisting.getProduct() + ":" + paramsExisting.getName(), paramsExisting); + } + + for (String name: params) { + name = prefix + name; + + if (map.containsKey(product + ":" + name)) + map.remove(product + ":" + name); + } + + List<OnapCommandParamEntity> es = new ArrayList<>(); + for (OnapCommandParamEntity e : map.values()) { + es.add(e); + } + + cache.persistProfile( es, profile); + } +} diff --git a/framework/src/main/java/org/onap/cli/fw/error/OnapCommandInvalidRegistration.java b/framework/src/main/java/org/onap/cli/fw/error/OnapCommandInvalidRegistration.java index 1c90e9a0..90f8c468 100644 --- a/framework/src/main/java/org/onap/cli/fw/error/OnapCommandInvalidRegistration.java +++ b/framework/src/main/java/org/onap/cli/fw/error/OnapCommandInvalidRegistration.java @@ -26,7 +26,7 @@ public class OnapCommandInvalidRegistration extends OnapCommandException { private static final long serialVersionUID = 7722163282274482532L; - public OnapCommandInvalidRegistration(Class cls) { + public OnapCommandInvalidRegistration(Class<?> cls) { super("0x2001", "Invalid commad class " + cls.getCanonicalName() + " registration, it should be derived from " + OnapCommand.class.getCanonicalName()); } diff --git a/framework/src/main/java/org/onap/cli/fw/output/print/OnapCommandPrint.java b/framework/src/main/java/org/onap/cli/fw/output/print/OnapCommandPrint.java index 8092c0fa..5527f94f 100644 --- a/framework/src/main/java/org/onap/cli/fw/output/print/OnapCommandPrint.java +++ b/framework/src/main/java/org/onap/cli/fw/output/print/OnapCommandPrint.java @@ -289,6 +289,6 @@ public class OnapCommandPrint { throw new OnapCommandOutputPrintingFailed(e); // NOSONAR } */ - return ""; + return ""; //NOSONAR } } diff --git a/framework/src/main/java/org/onap/cli/fw/schema/OnapCommandSchemaMerger.java b/framework/src/main/java/org/onap/cli/fw/schema/OnapCommandSchemaMerger.java index 9a6a4e78..0712603a 100644 --- a/framework/src/main/java/org/onap/cli/fw/schema/OnapCommandSchemaMerger.java +++ b/framework/src/main/java/org/onap/cli/fw/schema/OnapCommandSchemaMerger.java @@ -35,6 +35,10 @@ public class OnapCommandSchemaMerger { static Logger logger = LoggerFactory.getLogger(OnapCommandSchemaMerger.class); + private OnapCommandSchemaMerger(){ + //It is made private in order to resolve: Utility classes should not have public constructors + } + public static Map<String, Object> mergeSchemas(OnapCommand cmd) throws OnapCommandException { Map<String, Object> mergedResult = new LinkedHashMap<>(); diff --git a/framework/src/main/java/org/onap/cli/fw/store/OnapCommandExecutionStore.java b/framework/src/main/java/org/onap/cli/fw/store/OnapCommandExecutionStore.java index d8fdfab9..8f998190 100644 --- a/framework/src/main/java/org/onap/cli/fw/store/OnapCommandExecutionStore.java +++ b/framework/src/main/java/org/onap/cli/fw/store/OnapCommandExecutionStore.java @@ -458,8 +458,7 @@ public class OnapCommandExecutionStore { private File getExecutionDir(String executionId) throws OnapCommandExecutionNotFound { File []f = new File(getBasePath()).listFiles((dir, name) -> { - if (name.startsWith(executionId)) return true; - return false; + return name.startsWith(executionId); }); if (f.length == 0) { diff --git a/framework/src/main/java/org/onap/cli/fw/utils/OnapCommandDiscoveryUtils.java b/framework/src/main/java/org/onap/cli/fw/utils/OnapCommandDiscoveryUtils.java index 4cb95290..53cea2b6 100644 --- a/framework/src/main/java/org/onap/cli/fw/utils/OnapCommandDiscoveryUtils.java +++ b/framework/src/main/java/org/onap/cli/fw/utils/OnapCommandDiscoveryUtils.java @@ -478,7 +478,7 @@ public class OnapCommandDiscoveryUtils { public static List<Map<String, Object>> createTestSuite(String cmd, String version) throws OnapCommandException { - ArrayList<Map<String, Object>> testSamples = new ArrayList(); + ArrayList<Map<String, Object>> testSamples = new ArrayList<>(); List<Resource> resources = new ArrayList<>(); |