Yet some more changes (#91)

Do a lot of changes

Signed-off-by: RaphaelIT7 <[email protected]>

	modified:   .github/actions/build_and_push/action.yml
	modified:   .github/workflows/run_tests.yml
	modified:   .github/workflows/self_tests.yml
	modified:   docker/Dockerfile
	modified:   docker/docker-compose.yml
	modified:   docker/entrypoint.sh
	modified:   lua/gluatest/init.lua
	modified:   lua/gluatest/runner/log_helpers.lua
	modified:   lua/gluatest/runner/logger.lua
	modified:   lua/tests/gluatest/runner/log_helpers/getFileLines.lua

Author: RaphaelIT7

.github/actions/build_and_push/action.yml

@@ -49,15 +49,7 @@ runs:
       run: |
         cd ${{ inputs.path }}/docker
 
-        if [ "${{ inputs.gmod_branch }}" = "x86-64" ]; then
-          BASE=ghcr.io/cfc-servers/gluatest/64bit
-        elif [ "${{ inputs.gmod_branch }}" = "dev" ]; then
-          BASE=ghcr.io/cfc-servers/gluatest/dev
-        elif [ "${{ inputs.gmod_branch }}" = "prerelease" ]; then
-          BASE=ghcr.io/cfc-servers/gluatest/prerelease
-        else
-          BASE=ghcr.io/cfc-servers/gluatest
-        fi
+        BASE=ghcr.io/cfc-servers/gluatest/${{ inputs.gmod_branch }}
 
         rawVersionTag=${{ inputs.tag_name }}
         id=${{ inputs.game_version }}
@@ -101,14 +93,6 @@ runs:
     - name: Tag and push slim image
       shell: bash
       run: |
-        if [ "${{ inputs.gmod_branch }}" = "x86-64" ]; then
-          BASE=ghcr.io/cfc-servers/gluatest/64bit
-        elif [ "${{ inputs.gmod_branch }}" = "dev" ]; then
-          BASE=ghcr.io/cfc-servers/gluatest/dev
-        elif [ "${{ inputs.gmod_branch }}" = "prerelease" ]; then
-          BASE=ghcr.io/cfc-servers/gluatest/prerelease
-        else
-          BASE=ghcr.io/cfc-servers/gluatest
-        fi
+        BASE=ghcr.io/cfc-servers/gluatest/${{ inputs.gmod_branch }}
 
         docker push "$BASE" --all-tags

.github/workflows/run_tests.yml

@@ -59,8 +59,8 @@ on:
       branch:
         type: string
         required: false
-        description: "Which GMod branch to run your tests on. Must be: `live`, `x86-64`, `prerelease`, or `dev`"
-        default: "live"
+        description: "Which GMod branch to run your tests on. Must be: `public`, `x86-64`, `prerelease`, or `dev`"
+        default: "public"
 
       gluatest-repo:
         type: string
@@ -211,25 +211,10 @@ jobs:
 
       - name: Pull GLuaTest Runner
         if: inputs.dockerbuild != 'true'
+        env:
+          GMOD_BRANCH: "${{ inputs.branch }}"
         run: |
           cd $GITHUB_WORKSPACE/gluatest/docker
-          if [ ${{ inputs.branch }} = "x86-64" ]; then
-            echo "Updating compose file to use x86-64 image"
-            # Replace 'cfc-servers/gluatest' with 'cfc-servers/gluatest/64bit'
-            sed -i 's/cfc-servers\/gluatest/cfc-servers\/gluatest\/64bit/g' docker-compose.yml
-          fi
-
-          if [ ${{ inputs.branch }} = "dev" ]; then
-            echo "Updating compose file to use dev image"
-            # Replace 'cfc-servers/gluatest' with 'cfc-servers/gluatest/dev'
-            sed -i 's/cfc-servers\/gluatest/cfc-servers\/gluatest\/dev/g' docker-compose.yml
-          fi
-
-          if [ ${{ inputs.branch }} = "prerelease" ]; then
-            echo "Updating compose file to use prerelease image"
-            # Replace 'cfc-servers/gluatest' with 'cfc-servers/gluatest/prerelease'
-            sed -i 's/cfc-servers\/gluatest/cfc-servers\/gluatest\/prerelease/g' docker-compose.yml
-          fi
 
           docker compose pull
 
@@ -246,7 +231,7 @@ jobs:
             --build-arg="GMOD_BRANCH=${{ inputs.branch }}" \
             --build-arg="GLUATEST_REPO=${{ inputs.gluatest-repo }}.git" \
             --build-arg="GLUATEST_REF=${{ inputs.gluatest-ref }}" \
-            --tag ghcr.io/cfc-servers/gluatest:latest .
+            --tag ghcr.io/cfc-servers/gluatest/${{ inputs.branch }}:latest .
 
       - name: Run GLuaTest
         env:

.github/workflows/self_tests.yml

@@ -14,7 +14,7 @@ jobs:
           - "x86-64"
           - "dev"
           - "prerelease"
-          - "live"
+          - "public"
       fail-fast: false
 
     uses: ./.github/workflows/run_tests.yml

docker/Dockerfile

@@ -1,6 +1,6 @@
 FROM ghcr.io/cfc-servers/steamcmd:latest
 
-ARG GMOD_BRANCH=live
+ARG GMOD_BRANCH=public
 ARG GLUATEST_REF=main
 ARG GLUATEST_REPO=https://github.com/CFC-Servers/GLuaTest.git
 
@@ -13,19 +13,8 @@ ARG gmodroot=$home/gmodserver
 ARG server=$home/gmodserver/garrysmod
 
 USER steam
-RUN if [ "$GMOD_BRANCH" = "x86-64" ]; then \
-    echo "Downloading x86-64 branch"; \
-    ./steamcmd.sh +force_install_dir $gmodroot +login anonymous +app_update 4020 -beta x86-64 validate +quit; \
-elif [ "$GMOD_BRANCH" = "dev" ]; then \
-    echo "Downloading dev branch"; \
-    ./steamcmd.sh +force_install_dir $gmodroot +login anonymous +app_update 4020 -beta dev validate +quit; \
-elif [ "$GMOD_BRANCH" = "prerelease" ]; then \
-    echo "Downloading prerelease branch"; \
-    ./steamcmd.sh +force_install_dir $gmodroot +login anonymous +app_update 4020 -beta prerelease validate +quit; \
-else \
-    echo "Downloading live branch"; \
-    ./steamcmd.sh +force_install_dir $gmodroot +login anonymous +app_update 4020 validate +quit; \
-fi
+RUN echo "Downloading $GMOD_BRANCH branch"; \
+./steamcmd.sh +force_install_dir $gmodroot +login anonymous +app_update 4020 -beta $GMOD_BRANCH validate +quit;
 
 # Initial server config
 RUN touch $gmodroot/custom_server.cfg && \
@@ -70,5 +59,6 @@ RUN git clone --depth 1 $GLUATEST_REPO $server/addons/gluatest && \
 RUN mkdir --parents --verbose $server/data
 RUN mkdir --parents --verbose $server/addons/gluatest/data_static
 RUN echo "$GLUATEST_REF" > $server/addons/gluatest/data_static/gluatest_version.txt
+RUN echo "$GMOD_BRANCH" > $server/garrysmod_branch.txt
 
 ENTRYPOINT ["/home/steam/gmodserver/entrypoint.sh"]

docker/docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   runner:
-    image: ghcr.io/cfc-servers/gluatest:latest
+    image: ghcr.io/cfc-servers/gluatest/$GMOD_BRANCH:latest
     build: .
     container_name: gluatest_runner
     stop_grace_period: 2s

docker/entrypoint.sh

@@ -136,7 +136,7 @@ base_srcds_args=(
 )
 srcds_args="$EXTRA_STARTUP_ARGS ${base_srcds_args[@]}"
 
-if [ "$gmodbranch" = "x86-64" ]; then
+if [ -x "$gmodroot/srcds_run_x64" ]; then
     echo "Starting 64-bit server"
     unbuffer timeout "$timeout" "$gmodroot"/srcds_run_x64 "$srcds_args"
 else

lua/gluatest/init.lua

@@ -1,3 +1,10 @@
+local fileHandle = file.Open( "garrysmod_branch.txt", "rb", "MOD" ) --[[@as File]]
+if fileHandle then -- NOTE: This file is created in our docker file / BRANCH will only be accurate inside of the Docker images
+    BRANCH = fileHandle:ReadLine() -- prerelease shows unknown instead of prerelease as BRANCH. Not useful for tests.
+    BRANCH = string.Trim( BRANCH )
+    fileHandle:Close()
+end
+
 local RED = Color( 255, 0, 0 )
 
 --- @type VersionTools

lua/gluatest/runner/log_helpers.lua

@@ -61,13 +61,14 @@ LogHelpers.fileLinesCache = {
 --- Reads a given file path and returns the contents split by newline
 --- Cached for future calls
 --- @param filePath string
---- @return string[]
+--- @return string[]?
 function LogHelpers.getFileLines( filePath )
     local cached = LogHelpers.fileLinesCache:get( filePath )
     if cached then return cached end
 
     local cleanPath = LogHelpers.cleanPathForRead( filePath )
     local testFile = file.Open( cleanPath, "r", "LUA" ) --[[@as File]]
+    if not testFile then return nil end
     local fileContents = testFile:Read( testFile:Size() )
     testFile:Close()
 
@@ -126,6 +127,7 @@ end
 function LogHelpers.GetLineWithContext( path, line, context )
     if not context then context = 5 end
     local fileLines = LogHelpers.getFileLines( path )
+    if not fileLines then return {} end
 
     local lineWithContext = {}
     for i = line - context, line do

lua/gluatest/runner/logger.lua

@@ -109,6 +109,10 @@ function ResultLogger.logCodeContext( errInfo )
         end
     end
 
+    if lineCount == 0 then
+        MsgC( colors.grey,  "     | ", colors.red, "No source code found!\n" )
+    end
+
     if lineNumber == -1 then
         MsgC( colors.grey,  "     | ", colors.red, reason, "\n" )
     end

lua/tests/gluatest/runner/log_helpers/getFileLines.lua

@@ -20,6 +20,8 @@ local function fakeFileOpenResponse( read, size )
     }
 end
 
+-- We need this for getFileLines because LuaLS loves to complain even though expect( lines ).toNot.beNil() checks for it!
+---@diagnostic disable: need-check-nil
 return {
     groupName = "LogHelpers.getFileLines Tests",
 
@@ -38,6 +40,7 @@ return {
                 )
 
                 local lines = getFileLines( filePath )
+                expect( lines ).toNot.beNil()
                 expect( #lines ).to.equal( 3 )
                 expect( lines[1] ).to.equal( "Line1" )
                 expect( lines[2] ).to.equal( "Line2" )
@@ -55,6 +58,7 @@ return {
 
                 -- First call should open the file
                 local initialLines = getFileLines( filePath )
+                expect( initialLines ).toNot.beNil()
                 expect( #initialLines ).to.equal( 2 )
                 expect( initialLines[1] ).to.equal( "CachedLine1" )
                 expect( initialLines[2] ).to.equal( "CachedLine2" )
@@ -67,6 +71,7 @@ return {
 
                 -- Second call should use cache and not invoke file.Open
                 local cachedLines = getFileLines( filePath )
+                expect( cachedLines ).toNot.beNil()
                 expect( #cachedLines ).to.equal( 2 )
                 expect( cachedLines[1] ).to.equal( "CachedLine1" )
                 expect( cachedLines[2] ).to.equal( "CachedLine2" )
@@ -83,6 +88,7 @@ return {
                 )
 
                 local lines = getFileLines( filePath )
+                expect( lines ).toNot.beNil()
                 expect( #lines ).to.equal( 1 )
                 expect( lines[1] ).to.equal( "SingleLineContent" )
             end
@@ -97,6 +103,7 @@ return {
                 )
 
                 local lines = getFileLines( filePath )
+                expect( lines ).toNot.beNil()
                 expect( #lines ).to.equal( 1 )
                 expect( lines[1] ).to.equal( "" )
             end
@@ -107,7 +114,9 @@ return {
                 local filePath = "addons/testaddon/lua/tests/non_existent.txt"
 
                 stub( file, "Open" ).returns( nil )
-                expect( getFileLines, filePath ).to.err()
+
+                local lines = getFileLines( filePath )
+                expect( lines ).to.beNil()
             end
         }
     }