Merge pull request #18 from Telecominfraproject/OLS-563-version-client-tag-and-update-schema-ref

[OLS-563] Add version to ols-ucentral-client

Dockerfile

@@ -2,8 +2,11 @@ FROM debian:buster
 LABEL Description="Ucentral client (Build) environment"
 
 ARG HOME /root
-ARG EXTERNAL_LIBS ${HOME}/ucentral-external-libs
-
+ARG SCHEMA="3.2.7"
+ARG SCHEMA_VERSION="v${SCHEMA}"
+ARG SCHEMA_ZIP_FILE="${SCHEMA_VERSION}.zip"
+ARG SCHEMA_UNZIPPED="ols-ucentral-schema-${SCHEMA}"
+ARG OLS_SCHEMA_SRC="https://github.com/Telecominfraproject/ols-ucentral-schema/archive/refs/tags/${SCHEMA_ZIP_FILE}"
 SHELL ["/bin/bash", "-c"]
 
 RUN apt-get update -q -y  && apt-get -q -y --no-install-recommends install \
@@ -23,13 +26,16 @@ RUN apt-get update -q -y  && apt-get -q -y --no-install-recommends install \
 	autoconf \
 	libtool \
 	pkg-config \
-	libjsoncpp-dev
+	libjsoncpp-dev \
+        unzip
 
 RUN git config --global http.sslverify false
 RUN git clone https://github.com/DaveGamble/cJSON.git ${HOME}/ucentral-external-libs/cJSON/
 RUN git clone https://libwebsockets.org/repo/libwebsockets ${HOME}/ucentral-external-libs/libwebsockets/
 RUN git clone --recurse-submodules -b v1.50.0 --depth 1 --shallow-submodules https://github.com/grpc/grpc ${HOME}/ucentral-external-libs/grpc/
 RUN git clone --recursive --branch v7.1.4 https://github.com/zhaojh329/rtty.git ${HOME}/ucentral-external-libs/rtty/
+ADD ${OLS_SCHEMA_SRC} /tmp/
+
 
 # The following libs should be prebuilt in docker-build-env img to speed-up
 # recompilation of only the ucentral-client itself
@@ -62,3 +68,8 @@ RUN cd ${HOME}/ucentral-external-libs/rtty/ && \
 	cd build && \
 	cmake .. && \
 	make -j4
+
+RUN unzip /tmp/${SCHEMA_ZIP_FILE} -d ${HOME}/ucentral-external-libs/
+
+RUN cd ${HOME}/ucentral-external-libs/ && \
+    mv ${SCHEMA_UNZIPPED} ols-ucentral-schema

Makefile

@@ -50,8 +50,13 @@ build-ucentral-app: run-host-env
 	@echo Running ucentralclient docker-build-env container to build ucentral-client...;
 	docker exec -t ${CONTAINER_NAME} /root/ols-nos/docker-build-client.sh
 	docker cp ${CONTAINER_NAME}:/root/deliverables/ src/docker/
+	# copy the schema version, if it is there
+	docker cp ${CONTAINER_NAME}:/root/ucentral-external-libs/ols-ucentral-schema/schema.json src/docker/ || true
 	docker container stop ${CONTAINER_NAME} > /dev/null 2>&1 || true;
 	docker container rm ${CONTAINER_NAME} > /dev/null 2>&1 || true;
+	if [ -f version.json ]; then
+	    cp version.json src/docker/
+	fi
 
 build-ucentral-docker-img: build-ucentral-app
 	pushd src
@@ -91,6 +96,8 @@ clean:
 	rm -rf src/docker/deliverables || true;
 	rm -rf src/docker/lib* || true;
 	rm -rf src/docker/ucentral-client || true;
+	rm -rf src/docker/version.json || true;
+	rm -rf src/docker/schema.json || true;
 	rm -rf src/debian/ucentral-client.substvars 2>/dev/null || true;
 	rm -rf src/debian/shasta-ucentral-client.debhelper.log 2>/dev/null || true;
 	rm -rf src/debian/.debhelper src/debian/ucentral-client 2>/dev/null || true;

src/docker/Dockerfile

@@ -21,6 +21,8 @@ COPY /ucentral-client /usr/local/bin/ucentral-client
 COPY /rtty /usr/local/bin/
 COPY /lib* /usr/local/lib/
 
+COPY /version.jso[n] /etc/
+COPY /schema.jso[n] /etc/
 RUN ldconfig
 RUN ls -l /usr/local/bin/ucentral-client
 

src/scripts/OLS_NOS_fixups.script

@@ -7,3 +7,5 @@ ntp authenticate
 ip dhcp snooping
 ip dhcp snooping Vlan1
 ntp source-interface Vlan 1
+interface range Ethernet 0-100
+no ip dhcp snooping trust

src/scripts/docker-ucentral-client.sh

@@ -65,7 +65,6 @@ start() {
 			$(sonic-dockerlimits -sys ucentral_client) \
 			--net=$NET \
 			-e RUNTIME_OWNER=local \
-			-e UC_GATEWAY_ADDRESS=gw.dev01.apps.shastacloud.com \
 			--uts=host \
 			-v /etc/localtime:/etc/localtime:ro \
 			--tmpfs /tmp \

src/scripts/ucentral-client.sh

@@ -78,6 +78,17 @@ wait() {
     # This also means, that we won't start up untill this URI is accessible.
     while ! curl clientauth.one.digicert.com &>/dev/null; do sleep 1; done
 
+    # Enable DHCP trusting for uplink (Vlan1) iface
+    # It's needed to forward DHCP Discover (and replies) from/to DHCP server
+    # of (untrusted) port clients (EthernetX) of the same Vlan (Vlan1).
+    # Without this fix underlying Vlan members wouldn't be able to receive
+    # DHCP-lease IP
+    trusted_dhcp_if=`sudo -u admin -- bash "sonic-cli" "-c" "show ip arp" | grep -Eo "Ethernet[0-9]+"`
+    sudo -u admin -- "echo" "configure terminal" > /home/admin/fixup_scr.script
+    sudo -u admin -- "echo" "interface $trusted_dhcp_if" >> /home/admin/fixup_scr.script
+    sudo -u admin -- "echo" "ip dhcp snooping trust" >> /home/admin/fixup_scr.script
+    sudo -u admin -- bash "sonic-cli" "/home/admin/fixup_scr.script"
+
     # change admin password
     # NOTE: This could lead to access escalation, if you got image from running device
     if ! test -f /var/lib/ucentral/admin-cred.changed; then

src/ucentral-client/include/router-utils.h

@@ -46,16 +46,16 @@ struct ucentral_router {
 
 struct ucentral_router_fib_db_apply_args {
 	/* plat whould check info to determine if node channged */
-	int (*upd_cb)(const struct ucentral_router_fib_node *old,
+	int (*upd_cb)(const struct ucentral_router_fib_node *old_node,
 		      int olen,
-		      const struct ucentral_router_fib_node *new,
+		      const struct ucentral_router_fib_node *new_node,
 		      int nlen,
 		      void *arg);
 	/* prefix = new, info = new */
-	int (*add_cb)(const struct ucentral_router_fib_node *new,
+	int (*add_cb)(const struct ucentral_router_fib_node *new_node,
 		      int len, void *arg);
 	/* prefix = none */
-	int (*del_cb)(const struct ucentral_router_fib_node *old,
+	int (*del_cb)(const struct ucentral_router_fib_node *old_node,
 		      int len, void *arg);
 	void *arg;
 };

src/ucentral-client/platform/brcm-sonic/plat-revision.h

@@ -5,7 +5,7 @@
 #define STR(x) #x
 
 #define PLATFORM_REL_NUM 2.2
-#define PLATFORM_BUILD_NUM 3
+#define PLATFORM_BUILD_NUM 5
 
 #ifndef PLATFORM_REVISION
 #define PLATFORM_REVISION "Rel " XSTR(PLATFORM_REL_NUM) " build " XSTR(PLATFORM_BUILD_NUM)

src/ucentral-client/platform/example-platform/Makefile

@@ -2,4 +2,8 @@ plat.a: plat-example.o
 	ar crs $@ $^
 
 %.o: %.c
+ifdef PLATFORM_REVISION
+	gcc -c -o $@ ${CFLAGS} -I ./ -I ../../include -D PLATFORM_REVISION='"$(PLATFORM_REVISION)"' $^
+else
 	gcc -c -o $@ ${CFLAGS} -I ./ -I ../../include $^
+endif

src/ucentral-client/platform/example-platform/plat-example.c

@@ -2,6 +2,7 @@
 
 #include <ucentral-platform.h>
 #include <ucentral-log.h>
+#include <plat-revision.h>
 
 #define UNUSED_PARAM(param) (void)((param))
 
@@ -12,7 +13,11 @@ int plat_init(void)
 
 int plat_info_get(struct plat_platform_info *info)
 {
-	UNUSED_PARAM(info);
+	*info = (struct plat_platform_info){0};
+        snprintf(info->platform, sizeof info->platform, "%s", "Example Platform" );
+        snprintf(info->hwsku, sizeof info->hwsku, "%s", "example-platform-sku");
+        snprintf(info->mac, sizeof info->mac, "%s", "24:fe:9a:0f:48:f0");
+
 	return 0;
 }
 
@@ -156,10 +161,45 @@ int plat_port_num_get(uint16_t *num_of_active_ports)
 	UNUSED_PARAM(num_of_active_ports);
 	return 0;
 }
-
+int plat_revision_get(char *str, size_t str_max_len) 
+{
+        snprintf(str, str_max_len, PLATFORM_REVISION);
+        return 0;
+}
+int plat_reboot_cause_get(struct plat_reboot_cause *cause)
+{
+	UNUSED_PARAM(cause);
+	return 0;
+}
+int plat_event_subscribe(const struct plat_event_callbacks *cbs)
+{
+	UNUSED_PARAM(cbs);
+        return 0;
+}
+void plat_event_unsubscribe(void)
+{
+	return;
+}
+	
 int plat_running_img_name_get(char *str, size_t str_max_len)
 {
 	UNUSED_PARAM(str_max_len);
 	UNUSED_PARAM(str);
 	return 0;
 }
+int plat_metrics_save(const struct plat_metrics_cfg *cfg)
+{
+	UNUSED_PARAM(cfg);
+        return 0;
+}
+int plat_metrics_restore(struct plat_metrics_cfg *cfg)
+{
+	UNUSED_PARAM(cfg);
+        return 0;
+}
+int plat_run_script(struct plat_run_script *p)
+{
+	UNUSED_PARAM(p);
+        return 0;
+}
+

src/ucentral-client/platform/example-platform/plat-revision.h

@@ -0,0 +1,14 @@
+#ifndef _PLAT_REVISION
+#define _PLAT_REVISION
+
+#define XSTR(x) STR(x)
+#define STR(x) #x
+
+#define PLATFORM_REL_NUM 3.2.0
+#define PLATFORM_BUILD_NUM 5
+
+#ifndef PLATFORM_REVISION
+#define PLATFORM_REVISION "Rel " XSTR(PLATFORM_REL_NUM) " build " XSTR(PLATFORM_BUILD_NUM)
+#endif
+
+#endif

src/ucentral-client/proto.c

@@ -406,17 +406,46 @@ err:
 	proto_destroy_blob(&blob);
 }
 
-void
-connect_send(void)
-{
+static cJSON *readJsonFile(const char *filename) {
+
+	FILE *file = fopen(filename, "r");
+
+	if (!file) {
+		fprintf(stderr, "Error opening file: %s\n", filename);
+		return NULL;
+	}
+
+	cJSON *ret;
+
+	// Get the file size
+	fseek(file, 0, SEEK_END);
+	long fileSize = ftell(file);
+	fseek(file, 0, SEEK_SET);
+
+	// Read the entire file into a buffer
+	char *buffer = (char *)malloc(fileSize + 1);
+	fread(buffer, 1, fileSize, file);
+	buffer[fileSize] = '\0'; // Null-terminate the string
+
+	// Close the file
+	fclose(file);
+
+	ret = cJSON_Parse(buffer);
+
+	return ret;
+}
+
+void connect_send(void) {
 	/* WIP: TMP hardcode; to be removed*/
 	unsigned mac[6];
 	struct plat_platform_info pinfo = {0};
-	struct plat_metrics_cfg restore_metrics = { 0 };
+	struct plat_metrics_cfg restore_metrics = {0};
 	struct blob blob = {0};
 	uint64_t uuid_buf; /* fixed storage size */
 	cJSON *params;
 	cJSON *cap;
+	cJSON *ver;
+
 	int ret;
 
 	blob.obj = proto_new_blob("connect");
@@ -446,7 +475,6 @@ connect_send(void)
 	if (password) {
 		if (!cJSON_AddStringToObject(params, "password", password))
 			goto err;
-
 		memset(password, 0, strlen(password));
 		free(password);
 		password = NULL;
@@ -456,30 +484,60 @@ connect_send(void)
 	if (!cap)
 		goto err;
 
+	ver = cJSON_AddObjectToObject(cap, "version");
+	if (!ver)
+		goto err;
+
 	if (plat_info_get(&pinfo)) {
 		UC_LOG_CRIT("failed to get platform info");
-	} else {
-		if (!cJSON_AddStringToObject(cap, "compatible", pinfo.hwsku))
-			goto err;
-
-		if (!cJSON_AddStringToObject(cap, "model", pinfo.platform))
-			goto err;
 	}
 
+	if (!cJSON_AddStringToObject(cap, "serial", client.serial))
+		goto err;
+
+	if (!cJSON_AddStringToObject(cap, "firmware", client.firmware))
+		goto err;
+
+	cJSON *client_version_json = readJsonFile(client.ols_client_version_file);
+	if (!client_version_json)
+		goto err;
+	if (!cJSON_AddItemToObject(ver, "switch", client_version_json))
+		goto err;
+	else
+		UC_LOG_DBG("client version added to connect.capabilities.version");
+
+	cJSON *schema_version_json = readJsonFile(client.ols_schema_version_file);
+	if (!schema_version_json) {
+		UC_LOG_DBG("No schema version present.");
+	}
+	else {
+		if (!cJSON_AddItemToObject(ver, "schema", schema_version_json))
+			goto err;
+		else
+			UC_LOG_DBG("schema version added to connect.capabilities.version");
+	}
+
+	if (!cJSON_AddStringToObject(cap, "compatible", pinfo.hwsku))
+		goto err;
+
+	if (!cJSON_AddStringToObject(cap, "model", pinfo.platform))
+		goto err;
+
 	if (!cJSON_AddStringToObject(cap, "platform", "switch"))
 		goto err;
 
 	if (client.serial &&
-		  sscanf(client.serial, "%2x%2x%2x%2x%2x%2x",
-			  &mac[0], &mac[1], &mac[2], &mac[3], &mac[4], &mac[5]) == 6) {
+		sscanf(client.serial, "%2x%2x%2x%2x%2x%2x",
+			   &mac[0], &mac[1], &mac[2], &mac[3], &mac[4], &mac[5]) == 6) {
 		char label_mac[32];
 		snprintf(label_mac, sizeof label_mac,
-			 "%02x:%02x:%02x:%02x:%02x:%02x",
-			 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
+				 "%02x:%02x:%02x:%02x:%02x:%02x",
+				 mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
 		if (!cJSON_AddStringToObject(cap, "label_macaddr", label_mac)) {
 			goto err;
 		}
-	} else {
+	}
+	else {
 		UC_LOG_DBG("failed to parse serial as label_macaddr");
 	}
 
@@ -490,11 +548,11 @@ connect_send(void)
 
 		if (ucentral_metrics.state.enabled)
 			plat_state_poll(state_send,
-					ucentral_metrics.state.interval);
+							ucentral_metrics.state.interval);
 
 		if (ucentral_metrics.healthcheck.enabled)
 			plat_health_poll(health_send,
-					 ucentral_metrics.healthcheck.interval);
+							 ucentral_metrics.healthcheck.interval);
 	}
 
 	UC_LOG_DBG("xmit connect\n");

src/ucentral-client/ucentral-client.c

@@ -67,6 +67,8 @@ lws_protocols protocols[] = {
 struct client_config client = {
 	.redirector_file = "/tmp/ucentral-redirector.json",
 	.redirector_file_dbg = "/tmp/firstcontact.hdr",
+	.ols_schema_version_file = "/etc/schema.json",
+	.ols_client_version_file = "/etc/version.json",
 	.server = NULL,
 	.port = 15002,
 	.path = "/",
@@ -839,8 +841,10 @@ int main(void)
 		lws_service_tsi(context, 0, 0);
 
 		if (conn_successfull) {
-			if (password_len)
+			if (password_len) {
 				deviceupdate_send(password);
+				password_len = 0;
+			}
 			if (!reboot_reason_sent) {
 				device_rebootcause_send();
 				reboot_reason_sent = true;

src/ucentral-client/ucentral.h

@@ -41,6 +41,8 @@ extern "C" {
 struct client_config {
 	const char *redirector_file;
 	const char *redirector_file_dbg;
+	const char *ols_client_version_file;
+	const char *ols_schema_version_file;
 	const char *server;
 	int16_t port;
 	const char *path;

version.json

@@ -0,0 +1,5 @@
+{
+	"major": 3,
+	"minor": 2,
+	"patch": 7
+}