From 2c9faea63ca66c97a425cea7777c78501cdfacd4 Mon Sep 17 00:00:00 2001
From: Thomas Haller <thaller@redhat.com>
Date: Mon, 20 Mar 2023 07:53:21 +0100
Subject: [PATCH] contrib,tools: move "nm-in-container.sh" script to "tools"

This script seems very useful to me. Give it a more prominent place and
move it out from "contrib/scripts". Also do some further renaming.
---
 tools/nm-in-container/README.md               |  8 +++++++
 .../nm-in-container/data}/.gitignore          |  0
 .../data}/data-_nm-in-container-setup.sh      |  0
 .../nm-in-container/data}/data-etc-rc.local   |  0
 .../nm-in-container/data}/data-nm-deploy.sh   |  0
 .../data}/data-nm-env-prepare.sh              |  0
 .../nm-in-container/nm-in-container           | 24 +++++++++----------
 7 files changed, 20 insertions(+), 12 deletions(-)
 create mode 100644 tools/nm-in-container/README.md
 rename {contrib/scripts/nm-in-container.d => tools/nm-in-container/data}/.gitignore (100%)
 rename {contrib/scripts/nm-in-container.d => tools/nm-in-container/data}/data-_nm-in-container-setup.sh (100%)
 rename {contrib/scripts/nm-in-container.d => tools/nm-in-container/data}/data-etc-rc.local (100%)
 rename {contrib/scripts/nm-in-container.d => tools/nm-in-container/data}/data-nm-deploy.sh (100%)
 rename {contrib/scripts/nm-in-container.d => tools/nm-in-container/data}/data-nm-env-prepare.sh (100%)
 rename contrib/scripts/nm-in-container.sh => tools/nm-in-container/nm-in-container (96%)

diff --git a/tools/nm-in-container/README.md b/tools/nm-in-container/README.md
new file mode 100644
index 0000000000..26c653541d
--- /dev/null
+++ b/tools/nm-in-container/README.md
@@ -0,0 +1,8 @@
+Run NetworkManager in Container for Development
+===============================================
+
+Run `nm-in-container` script for running NetworkManager in a podman container.
+This is useful for testing NetworkManager for development.
+
+Try `./nm-in-container --help` to see options.  See the bash history inside the
+container for useful commands.
diff --git a/contrib/scripts/nm-in-container.d/.gitignore b/tools/nm-in-container/data/.gitignore
similarity index 100%
rename from contrib/scripts/nm-in-container.d/.gitignore
rename to tools/nm-in-container/data/.gitignore
diff --git a/contrib/scripts/nm-in-container.d/data-_nm-in-container-setup.sh b/tools/nm-in-container/data/data-_nm-in-container-setup.sh
similarity index 100%
rename from contrib/scripts/nm-in-container.d/data-_nm-in-container-setup.sh
rename to tools/nm-in-container/data/data-_nm-in-container-setup.sh
diff --git a/contrib/scripts/nm-in-container.d/data-etc-rc.local b/tools/nm-in-container/data/data-etc-rc.local
similarity index 100%
rename from contrib/scripts/nm-in-container.d/data-etc-rc.local
rename to tools/nm-in-container/data/data-etc-rc.local
diff --git a/contrib/scripts/nm-in-container.d/data-nm-deploy.sh b/tools/nm-in-container/data/data-nm-deploy.sh
similarity index 100%
rename from contrib/scripts/nm-in-container.d/data-nm-deploy.sh
rename to tools/nm-in-container/data/data-nm-deploy.sh
diff --git a/contrib/scripts/nm-in-container.d/data-nm-env-prepare.sh b/tools/nm-in-container/data/data-nm-env-prepare.sh
similarity index 100%
rename from contrib/scripts/nm-in-container.d/data-nm-env-prepare.sh
rename to tools/nm-in-container/data/data-nm-env-prepare.sh
diff --git a/contrib/scripts/nm-in-container.sh b/tools/nm-in-container/nm-in-container
similarity index 96%
rename from contrib/scripts/nm-in-container.sh
rename to tools/nm-in-container/nm-in-container
index 4e405ea5f7..96f92d7534 100755
--- a/contrib/scripts/nm-in-container.sh
+++ b/tools/nm-in-container/nm-in-container
@@ -44,7 +44,7 @@ if [ -z "$BASE_IMAGE" ]; then
 fi
 
 BASEDIR_NM="$(readlink -f "$(dirname "$(readlink -f "$0")")/../..")"
-BASEDIR="$BASEDIR_NM/contrib/scripts/nm-in-container.d"
+BASEDIR_DATA="$BASEDIR_NM/tools/nm-in-container/data"
 
 BASEDIR_NM_CI=
 if [ -d "$BASEDIR_NM/.git/NetworkManager-ci" ] ; then
@@ -124,10 +124,10 @@ create_dockerfile() {
     local CONTAINERFILE="$1"
     local BASE_IMAGE="$2"
 
-    cp "$BASEDIR_NM/contrib/scripts/NM-log" "$BASEDIR/data-NM-log"
-    CLEANUP_FILES+=( "$BASEDIR/data-NM-log" )
+    cp "$BASEDIR_NM/contrib/scripts/NM-log" "$BASEDIR_DATA/data-NM-log"
+    CLEANUP_FILES+=( "$BASEDIR_DATA/data-NM-log" )
 
-    cat <<EOF | tmp_file "$BASEDIR/data-motd"
+    cat <<EOF | tmp_file "$BASEDIR_DATA/data-motd"
 *** nm-in-container:
 
 find NetworkManager bind mounted at $BASEDIR_NM
@@ -205,7 +205,7 @@ Run NM-ci tests after creating eth1 with
 \`nm-env-prepare.sh --prefix eth -i 1 && sleep 1 && nmcli device connect eth1\`.
 EOF
 
-    cat <<EOF | tmp_file "$BASEDIR/data-bashrc.my"
+    cat <<EOF | tmp_file "$BASEDIR_DATA/data-bashrc.my"
 alias m="make -j 8"
 alias n="ninja -C build"
 
@@ -254,7 +254,7 @@ if test "\$SHOW_MOTD" != 0; then
 fi
 EOF
 
-    cat <<EOF | tmp_file "$BASEDIR/data-90-my.conf"
+    cat <<EOF | tmp_file "$BASEDIR_DATA/data-90-my.conf"
 [main]
 no-auto-default=*
 debug=RLIMIT_CORE,fatal-warnings
@@ -272,10 +272,10 @@ match-device=interface-name:net*,interface-name:eth*
 managed=1
 EOF
 
-    cat <<EOF | tmp_file "$BASEDIR/data-95-user.conf"
+    cat <<EOF | tmp_file "$BASEDIR_DATA/data-95-user.conf"
 EOF
 
-    cat <<EOF | tmp_file "$BASEDIR/data-bash_history" 600
+    cat <<EOF | tmp_file "$BASEDIR_DATA/data-bash_history" 600
 NM-log
 NM-log /tmp/nm-log.txt
 behave -f html --stop -t ipv4_method_static_with_IP ./features/scenarios/ipv4.feature
@@ -305,17 +305,17 @@ systemctl daemon-reload ; systemctl restart NetworkManager
 systemctl status NetworkManager
 EOF
 
-    cat <<EOF | tmp_file "$BASEDIR/data-gdbinit"
+    cat <<EOF | tmp_file "$BASEDIR_DATA/data-gdbinit"
 set history save
 set history filename ~/.gdb_history
 EOF
 
-    cat <<EOF | tmp_file "$BASEDIR/data-gdb_history" 600
+    cat <<EOF | tmp_file "$BASEDIR_DATA/data-gdb_history" 600
 run
 run --debug 2>&1 | tee /tmp/nm-log.txt
 EOF
 
-    cat <<EOF | tmp_file "$BASEDIR/data-behaverc" 600
+    cat <<EOF | tmp_file "$BASEDIR_DATA/data-behaverc" 600
 [behave.formatters]
 html = behave_html_formatter:HTMLFormatter
 EOF
@@ -547,7 +547,7 @@ do_clean() {
 do_build() {
     container_image_exists "$CONTAINER_NAME_REPOSITORY:$CONTAINER_NAME_TAG" && return 0
 
-    CONTAINERFILE="$BASEDIR/containerfile"
+    CONTAINERFILE="$BASEDIR_DATA/containerfile"
     create_dockerfile "$CONTAINERFILE" "$BASE_IMAGE"
     podman build --squash-all --tag "$CONTAINER_NAME_REPOSITORY:$CONTAINER_NAME_TAG" -f "$CONTAINERFILE"
 }