Screenshot in Gauge Report shows only black image, please help #2722

antondebeer · 2025-03-31T11:40:29Z

antondebeer
Mar 31, 2025

I am running Gauge from Jenkins inside a docker. Whenever I have a failed test the screenshot shows only a black image not the screengrab, see screenshot.

Here is some files that might help:
My Dockerfile:
FROM ubuntu:20.04

Ensure system is up to date before installing packages

RUN apt-get update && apt-get upgrade -y && apt-get install -y --fix-missing
curl
zip
openjdk-17-jdk
apt-transport-https
gnupg2
ca-certificates
wget
unzip
xvfb
libxi6
libgconf-2-4 &&
apt-get clean && rm -rf /var/lib/apt/lists/*

Install Google Chrome

RUN wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | apt-key add - &&
echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" | tee /etc/apt/sources.list.d/google-chrome.list &&
apt-get update && apt-get install -y google-chrome-stable &&
google-chrome-stable --version

Download the correct ChromeDriver version and clean up

RUN wget https://storage.googleapis.com/chrome-for-testing-public/134.0.6998.35/linux64/chromedriver-linux64.zip &&
unzip chromedriver-linux64.zip &&
mv chromedriver-linux64/chromedriver /usr/local/bin/ &&
rm -rf chromedriver-linux64.zip

Install Gauge

RUN curl -SsL https://downloads.gauge.org/stable | sh

Install Gauge plugins

RUN gauge install java
&& gauge install screenshot
&& gauge install html-report
&& gauge install xml-report
&& gauge install json-report
&& gauge install flash

Set ChromeDriver path in the environment

ENV PATH="/usr/local/bin/chromedriver:$PATH"
ENV PATH=$HOME/.gauge:$PATH

Set Java Home for Java tools like Gauge

ENV JAVA_HOME=/usr/lib/jvm/java-17-openjdk-amd64

Set the working directory in the container

WORKDIR /workspace

Copy the gradlew and gradlew.bat files into the /workspace directory

COPY gradlew /workspace/gradlew
COPY gradlew.bat /workspace/gradlew.bat

Set executable permissions for gradlew

RUN chmod +x /workspace/gradlew

Copy the entire project into the container

COPY . /workspace/

Log versions for Chrome and ChromeDriver

RUN google-chrome-stable --version
RUN chromedriver --version

Set the default command

CMD ["bash"]

And my Jenkins Pipeline:
pipeline {
agent any

parameters {
    string(name: 'SPEC_FILE', defaultValue: 'logintests.spec', description: 'Gauge spec file to run')
}

environment {
    SELENIUM_CONTAINER = "selenium-chrome"
    NETWORK_NAME = "selenium-network"
}

stages {
    stage('Checkout') {
        steps {
            echo '--- Checkout code from GIT ---'
            dir('/var/jenkins_home/workspace/testing-gauge-2') {
                checkout scm: [$class: 'GitSCM',
                              userRemoteConfigs: [[url: 'xxx']],
                              branches: [[name: 'main' ]]], changelog: false, poll: false
            }
        }
    }

    stage('Create Docker Network') {
        steps {
            script {
                sh """
                    # Create network if not exists
                    docker network ls | grep -w $NETWORK_NAME || docker network create $NETWORK_NAME
                    echo "Docker network $NETWORK_NAME created or already exists."
                """
            }
        }
    }

    stage('Start Selenium Container') {
        steps {
            script {
                sh """
                    # Stop and remove existing Selenium container (if it exists)
                    if [ \$(docker ps -aq -f name=$SELENIUM_CONTAINER) ]; then
                        docker stop $SELENIUM_CONTAINER || true
                        docker rm $SELENIUM_CONTAINER || true
                    fi
                    
                    # Start Selenium standalone Chrome container on the network
                    docker run -d --name $SELENIUM_CONTAINER --network $NETWORK_NAME -p 4444:4444 \
                    -v /dev/shm:/dev/shm selenium/standalone-chrome:latest
                    echo "Selenium container started."
                """
            }
        }
    }

    stage('Cleanup Docker Resources') {
        steps {
            script {
                sh """
                    # Clean up unused Docker resources
                    docker system prune -a -f
                    echo "Docker resources cleaned up."
                """
            }
        }
    }

    stage('Build Docker Image') {
        steps {
            script {
                 def imageExists = sh(script: "docker images -q test", returnStdout: true).trim()
    
                  if (!imageExists) {
                    echo "Building Docker image as it does not exist..."
                    sh 'docker build -t test .'
                  } else {
                      echo "Docker image already exists. Skipping build."
                  }
    
                // Stop and remove any existing container with the same name
                sh 'docker rm -f test-container || true'
    
                // Run the container in detached mode and keep it alive
                sh 'docker run -d --name test-container test tail -f /dev/null'
    
                // Check the ChromeDriver version inside the container
                sh 'docker exec test-container chromedriver --version'
            }
        }
    }
    stage('Run Gauge Tests') {
        steps {
            echo '--- Run Gauge Tests ---'
            script {
                // Run Gauge tests in the Docker container
                sh """
                    echo "Docker network: $NETWORK_NAME"
                    docker network ls
                    
                    # Start Docker container with necessary setups (Xvfb + Chrome)
                    docker run --rm --network $NETWORK_NAME --name test-runner \
                        -v /var/lib/docker/volumes/4461c04a02dd4c1129b21d6cc1d5229ce3ef375019d2b41a5c631daa6a0cecc7/_data/workspace/testing-gauge-2:/workspace \
                        -v $HOME/.gradle:/root/.gradle \
                        -w /workspace test bash -c "
                        # Start Xvfb in the background
                        Xvfb :99 -screen 0 1280x1024x24 & sleep 3 && 
                        export DISPLAY=:99 &&
                        export GRADLE_OPTS=-Dchromeoptions.args=--headless,--no-sandbox,--disable-gpu,--disable-dev-shm-usage &&
                        chmod +x gradlew &&
                        ./gradlew clean build gauge -Ptags=${TAGS} -PspecsDir=specs/${SPEC_FILE}"
                """
            }
        }
    }
    
}

post {
    always {
        script {
            echo '--- Copying Gauge Reports from Docker Container ---'
            sh """
                # Ensure test-runner container exists before copying
                docker ps -a | grep test-runner && docker cp test-runner:/workspace/reports ${WORKSPACE}/ || true
                
                # Check what is in the reports directory
            echo '--- Listing contents of reports directory ---'
            ls -R ${WORKSPACE}/reports/html-report/images
            """
            
        

            echo '--- Archiving Gauge Reports ---'
            archiveArtifacts artifacts: 'reports/**', allowEmptyArchive: true
            //archiveArtifacts artifacts: 'reports/screenshots/**', allowEmptyArchive: true

            
            publishHTML target: [
                allowMissing: false,
                alwaysLinkToLastBuild: false,
                keepAll: true,
                reportDir: 'reports/html-report',
                reportFiles: 'index.html',
                reportName: 'Gauge Report'
            ]
        }
    }
    failure {
        script {
            echo "Build failed! Check logs and reports."
            archiveArtifacts artifacts: 'reports/html-report/images/**', allowEmptyArchive: true
        }
    }
    success {
        script {
            echo "Build completed successfully!"
        }
    }
}

}

zabil · 2025-03-31T11:46:43Z

zabil
Mar 31, 2025
Maintainer

You'll need to implement a custom screenshot handler for this

refer https://docs.gauge.org/writing-specifications.html?os=macos&language=java&ide=vscode#taking-custom-screenshots

1 reply

antondebeer Mar 31, 2025
Author

Thank you Zabil, it worked!!!!

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Screenshot in Gauge Report shows only black image, please help #2722

Uh oh!

{{title}}

Uh oh!

Replies: 1 comment 1 reply

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

Screenshot in Gauge Report shows only black image, please help #2722

Uh oh!

antondebeer Mar 31, 2025

Ensure system is up to date before installing packages

Install Google Chrome

Download the correct ChromeDriver version and clean up

Install Gauge

Install Gauge plugins

Set ChromeDriver path in the environment

Set Java Home for Java tools like Gauge

Set the working directory in the container

Copy the gradlew and gradlew.bat files into the /workspace directory

Set executable permissions for gradlew

Copy the entire project into the container

Log versions for Chrome and ChromeDriver

Set the default command

Replies: 1 comment · 1 reply

Uh oh!

zabil Mar 31, 2025 Maintainer

Uh oh!

antondebeer Mar 31, 2025 Author

antondebeer
Mar 31, 2025

Replies: 1 comment 1 reply

zabil
Mar 31, 2025
Maintainer

antondebeer Mar 31, 2025
Author