Add scripts for building locally O-DU with 3GPP Rel-18 YANG models.

[sim/o1-interface.git] / ntsimulator / deploy / o-ran-du-rel-18 / get_3gpp_yangs.sh

diff --git a/ntsimulator/deploy/o-ran-du-rel-18/get_3gpp_yangs.sh b/ntsimulator/deploy/o-ran-du-rel-18/get_3gpp_yangs.sh
new file mode 100755 (executable)
index 0000000..9b49179
--- /dev/null
+++ b/ntsimulator/deploy/o-ran-du-rel-18/get_3gpp_yangs.sh
@@ -0,0 +1,64 @@
+#!/bin/bash
+#
+# Copyright 2023 highstreet technologies GmbH and others
+#
+# 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.
+
+# Script which downloads the 3GPP YANG models in preparation for loading them in the O1 Simulator
+
+DIRBIN="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+DIR_AVAILABLE_YANGS="$DIRBIN/available-yangs"
+DIR_YANGS="$DIRBIN/yang"
+FILE_DOWNLOADZIP="$DIRBIN/yangs.zip"
+TMPFOLDER="/tmp/o1-yangs"
+UNZIP=$(which unzip)
+if [ -z "$UNZIP" ]; then
+    echo "unable to find unzip. please install."
+    exit 1
+fi
+
+# download
+if [ ! -f "$FILE_DOWNLOADZIP" ]; then
+    wget -O "$FILE_DOWNLOADZIP" "https://forge.3gpp.org/rep/sa5/MnS/-/archive/Rel-18/MnS-Rel-18.zip?path=yang-models"
+fi
+if [ ! -d "$DIR_AVAILABLE_YANGS" ]; then
+    mkdir "$DIR_AVAILABLE_YANGS"
+fi
+# cleanup yang folders
+rm -rf "$DIR_AVAILABLE_YANGS/"*
+rm "$DIR_YANGS/*"
+unzip -uj yangs.zip -d "$TMPFOLDER"
+cp -r "$TMPFOLDER/"* "$DIR_AVAILABLE_YANGS/"
+
+rm "$FILE_DOWNLOADZIP"
+
+# fill yang folder
+cp "$DIR_AVAILABLE_YANGS/"_3gpp-common*.yang "$DIR_YANGS"
+cp "$DIR_AVAILABLE_YANGS/"ietf-*.yang "$DIR_YANGS/"
+
+declare special_files=(
+    "_3gpp-5g-common-yang-types.yang"
+    "_3gpp-5gc-nrm-configurable5qiset.yang"
+    "_3gpp-nr-nrm-bwp.yang"
+    "_3gpp-nr-nrm-ep.yang"
+    "_3gpp-nr-nrm-gnbcucpfunction.yang"
+    "_3gpp-nr-nrm-gnbcuupfunction.yang"
+    "_3gpp-nr-nrm-gnbdufunction.yang"
+    "_3gpp-nr-nrm-nrsectorcarrier.yang"
+    "_3gpp-nr-nrm-nrcelldu.yang"
+)
+
+for file in "${special_files[@]}"
+do
+   cp "$DIR_AVAILABLE_YANGS/$file" "$DIR_YANGS/"
+done