1 /*************************************************************************
3 * Copyright 2020 highstreet technologies GmbH and others
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 ***************************************************************************/
26 #define NTS_VERSION_FALLBACK "1.2.0"
28 #define ENV_VAR_NTS_MANUAL "NTS_MANUAL"
29 #define ENV_VAR_NTS_BUILD_VERSION "NTS_BUILD_VERSION"
30 #define ENV_VAR_NTS_BUILD_TIME "NTS_BUILD_DATE"
31 #define ENV_VAR_NTS_FUNCTION_TYPE "NTS_FUNCTION_TYPE"
32 #define ENV_VAR_NTS_NF_STANDALONE_START_FEATURES "NTS_NF_STANDALONE_START_FEATURES"
33 #define ENV_VAR_NTS_NF_MOUNT_POINT_ADDRESSING_METHOD "NTS_NF_MOUNT_POINT_ADDRESSING_METHOD"
35 #define ENV_VAR_DOCKER_REPOSITORY "DOCKER_REPOSITORY"
36 #define ENV_VAR_DOCKER_ENGINE_VERSION "DOCKER_ENGINE_VERSION"
37 #define ENV_VAR_HOSTNAME "HOSTNAME"
38 #define ENV_VAR_IPV6ENABLED "IPv6_ENABLED"
39 #define ENV_VAR_SSH_CONNECTIONS "SSH_CONNECTIONS"
40 #define ENV_VAR_TLS_CONNECTIONS "TLS_CONNECTIONS"
42 #define ENV_VAR_HOST_IP "NTS_HOST_IP"
43 #define ENV_VAR_HOST_BASE_PORT "NTS_HOST_BASE_PORT"
44 #define ENV_VAR_HOST_NETCONF_SSH_BASE_PORT "NTS_HOST_NETCONF_SSH_BASE_PORT"
45 #define ENV_VAR_HOST_NETCONF_TLS_BASE_PORT "NTS_HOST_NETCONF_TLS_BASE_PORT"
46 #define ENV_VAR_HOST_TRANSFER_FTP_BASE_PORT "NTS_HOST_TRANSFER_FTP_BASE_PORT"
47 #define ENV_VAR_HOST_TRANSFER_SFTP_BASE_PORT "NTS_HOST_TRANSFER_SFTP_BASE_PORT"
49 #define ENV_VAR_SDN_CONTROLLER_PROTOCOL "SDN_CONTROLLER_PROTOCOL"
50 #define ENV_VAR_SDN_CONTROLLER_IP "SDN_CONTROLLER_IP"
51 #define ENV_VAR_SDN_CONTROLLER_PORT "SDN_CONTROLLER_PORT"
52 #define ENV_VAR_SDN_CONTROLLER_CALLHOME_PORT "SDN_CONTROLLER_CALLHOME_PORT"
53 #define ENV_VAR_SDN_CONTROLLER_USERNAME "SDN_CONTROLLER_USERNAME"
54 #define ENV_VAR_SDN_CONTROLLER_PASSWORD "SDN_CONTROLLER_PASSWORD"
56 #define ENV_VAR_VES_COMMON_HEADER_VERSION "VES_COMMON_HEADER_VERSION"
57 #define ENV_VAR_VES_ENDPOINT_PROTOCOL "VES_ENDPOINT_PROTOCOL"
58 #define ENV_VAR_VES_ENDPOINT_IP "VES_ENDPOINT_IP"
59 #define ENV_VAR_VES_ENDPOINT_PORT "VES_ENDPOINT_PORT"
60 #define ENV_VAR_VES_ENDPOINT_AUTH_METHOD "VES_ENDPOINT_AUTH_METHOD"
61 #define ENV_VAR_VES_ENDPOINT_USERNAME "VES_ENDPOINT_USERNAME"
62 #define ENV_VAR_VES_ENDPOINT_PASSWORD "VES_ENDPOINT_PASSWORD"
63 #define ENV_VAR_VES_ENDPOINT_CERTIFICATE "VES_ENDPOINT_CERTIFICATE"
67 NTS_MODE_CONTAINER_INIT,
70 NTS_MODE_NETWORK_FUNCTION,
72 NTS_MODE_GENERATE_DATA,
80 char **argv; //no-copy
83 unsigned int fixed_seed;
86 bool print_root_paths;
87 char *print_structure_xpath;
88 } framework_arguments_t;
96 char *nf_standalone_start_features;
97 char *nf_mount_point_addressing_method;
101 char *docker_repository;
102 char *docker_engine_version;
108 uint16_t ssh_connections;
109 uint16_t tls_connections;
110 uint16_t ftp_connections;
111 uint16_t sftp_connections;
117 uint16_t ssh_base_port;
118 uint16_t tls_base_port;
119 uint16_t ftp_base_port;
120 uint16_t sftp_base_port;
127 uint16_t callhome_port;
133 char *common_header_version;
143 } framework_environment_t;
154 } supervisor_rules_t;
159 } custom_list_instances_t;
170 int excluded_modules_count;
171 char **excluded_modules;
173 int excluded_features_count;
174 char **excluded_features;
179 supervisor_rules_t *rules;
183 int debug_max_string_size;
185 int excluded_modules_count;
186 char **excluded_modules;
188 int default_list_instances;
190 int custom_list_instances_count;
191 custom_list_instances_t *custom_list_instances;
193 int restrict_schema_count;
194 restrict_schema_t *restrict_schema;
195 } datastore_generate;
198 bool random_generation_enabled;
200 int preg_operational_count;
201 char **preg_operational;
203 int preg_running_count;
205 } datastore_populate;
206 } framework_config_t;
208 extern framework_arguments_t framework_arguments;
209 extern framework_environment_t framework_environment;
210 extern framework_config_t framework_config;
212 volatile sig_atomic_t framework_sigint;
214 int framework_init(int argc, char **argv);
215 void framework_free(void);