Merge pull request #6186: Refactor tools/launchdev.sh to use tmux

Author: cognifloyd

.github/workflows/ci.yaml

@@ -282,12 +282,13 @@ jobs:
       - name: Compress Service Logs Before upload
         if: ${{ failure() }}
         run: |
+          ./tools/launchdev.sh stop # stop st2 before collecting logs
           tar cvzpf logs.tar.gz logs/*
       - name: Upload StackStorm services Logs
         if: ${{ failure() }}
         uses: actions/upload-artifact@v2
         with:
-          name: logs
+          name: logs-py${{ matrix.python-version }}
           path: logs.tar.gz
           retention-days: 7
       - name: Stop Redis Service Container
@@ -690,12 +691,13 @@ jobs:
       - name: Compress Service Logs Before upload
         if: ${{ failure() && env.TASK == 'ci-integration' }}
         run: |
+          ./tools/launchdev.sh stop # stop st2 before collecting logs
           tar cvzpf logs.tar.gz logs/*
       - name: Upload StackStorm services Logs
         if: ${{ failure() && env.TASK == 'ci-integration' }}
         uses: actions/upload-artifact@v2
         with:
-          name: logs
+          name: logs-py${{ matrix.python-version }}-nose-${{ matrix.nosetests_node_index }}
           path: logs.tar.gz
           retention-days: 7
       - name: Stop Redis Service Container

CHANGELOG.rst

@@ -18,6 +18,7 @@ Changed
 * Switch to python3's standard lib unittest from unittest2, a backport of python3 unittest features for python2. #6187 (by @nzlosh)
 * Drop Python 3.6 testing in CircleCI. #6080
   Contributed by (@philipphomberger Schwarz IT KG)
+* Refactor `tools/launchdev.sh` to use `tmux` instead of `screen`. #6186 (by @nzlosh and @cognifloyd)
 
 Added
 ~~~~~

dev_docs/Troubleshooting_Guide.rst

@@ -40,17 +40,15 @@ As we can see from above output port ``9101`` is not even up. To verify this let
   vagrant  32403  0.2  1.5  79228 31364 pts/3    Ss+  18:27   0:00 /home/vagrant/git/st2/virtualenv/bin/python
   ./virtualenv/bin/gunicorn st2stream.wsgi:application -k eventlet -b 0.0.0.0:9102 --workers 1
 
-- This suggests that the API process crashed, we can verify that by running ``screen -ls``.::
+- This suggests that the API process crashed, we can verify that by running ``tmux ls``.::
 
 .. code:: bash
 
-  $ screen -ls
-    There are screens on:
-	 15781.st2-auth	(04/26/2016 06:39:10 PM)	(Detached)
-	 15778.st2-notifier	(04/26/2016 06:39:10 PM)	(Detached)
-	 15767.st2-sensorcontainer	(04/26/2016 06:39:10 PM)	(Detached)
-	 15762.st2-stream	(04/26/2016 06:39:10 PM)	(Detached)
-    3 Sockets in /var/run/screen/S-vagrant.
+  $ tmux ls
+  st2-auth: 1 windows (created Fri Apr 19 00:42:58 2024)
+  st2-notifier: 1 windows (created Fri Apr 19 00:42:58 2024)
+  st2-sensorcontainer: 1 windows (created Fri Apr 19 00:42:58 2024)
+  st2-stream: 1 windows (created Fri Apr 19 00:42:58 2024)
 
 - Now let us check the logs for any errors:
 

scripts/github/prepare-integration.sh

@@ -30,23 +30,23 @@ echo ""
 python ./st2client/setup.py develop
 st2 --version
 
-# Clean up old screen log files
-rm -f logs/screen-*.log
+# Clean up old st2 log files
+rm -f logs/st2*.log
 
 # ::group::/::endgroup:: is helpful github actions syntax to fold this section.
 echo ::group::launchdev.sh start -x
 
-# start dev environment in screens
+# start dev environment in tmux
 ./tools/launchdev.sh start -x
 
 # Give processes some time to start and check logs to see if all the services
 # started or if there was any error / failure
-echo "Giving screen processes some time to start..."
+echo "Giving st2 processes some time to start..."
 sleep 10
 
-echo " === START: Catting screen process log files. ==="
-cat logs/screen-*.log
-echo " === END: Catting screen process log files. ==="
+echo " === START: Catting st2 process log files. ==="
+cat logs/st2-*.log
+echo " === END: Catting st2 process log files. ==="
 
 # github actions: fold for launchdev.sh start -x
 echo ::endgroup::