Add hooks for server teardown

[simonauner]

Is your feature request related to a problem? Please describe.
Not really, we manage a workaround with docker-compose for now.

Describe the solution you'd like
I would like to be able to run a server (https://github.com/playwright-community/jest-playwright#start-a-server) as a docker image. I got the tests running by specifying

command: "docker run ${IMAGE}:${TAG} -p 3000:3000"

But jest-playwright isn't able to stop the process after the tests are done with the message

Jest did not exit one second after the test run has completed.

If possible I would like to have a tearDownServer option where I could kill off the docker processes myself.

Describe alternatives you've considered
I've tried to include the setup objects from https://github.com/playwright-community/jest-process-manager but didn't understand how they would cooperate with jest-playwright.config.js. Maybe it's just me being confused over configuration setup?

[simonauner]

If anyone else stumbles this problem, which is "I want to run the server as a docker container", here's our current workaround.

package.json

{
    "name": "ui-tests",
    "version": "1.0.0",
    "description": "",
    "scripts": {
        "test": "jest || true",
        "posttest": "docker ps | grep '<insert name of your application image>' | awk '{ print $1 }' | xargs docker stop",
    },
    "author": "",
    "license": "ISC",
    "dependencies": {
        "jest": "^26.6.3",
        "jest-playwright-preset": "^1.4.7",
        "playwright": "^1.9.1"
    },
    "jest": {
        "preset": "jest-playwright-preset"
    },
    "devDependencies": {}
}

jest-playwright-config.js

module.exports = {
    serverOptions: {
        command: `docker run --env-file=../.dockerenv -a STDIN -p 3001:3000 ${image}:${tag}`,
        port: 3001,
    },
};

-a STDIN prevents the Jest did not exit one second after the test run has completed. message from showing up and actually stops the test run after it has completed.

The posttest npm task finds the image that was started and shuts it down.
This has been found working in Azure pipelines vmImage ubuntu-18.04 as well:

jobs:
    - job: build
      # ... builds and publishes a docker image to ACR (<insert name of your ACR>.azurecr.io/<insert name of your application image>:$(Build.BuildNumber))
    - job: ui_tests
      displayName: "UI tests"
      dependsOn: build
      variables:
        dockerRegistryServiceConnection: "<insert ID of service connection>"
        containerRegistry: "<insert name of your ACR>.azurecr.io"
        microserviceName: '<insert name of your application image>'
      pool:
          vmImage: "ubuntu-18.04"
      steps:
        - task: Docker@2
          displayName: Login to ACR
          inputs:
            command: login
            containerRegistry: ${{ variables.dockerRegistryServiceConnection }}
        - bash: |
            npm install
          displayName: npm install
        - bash: |
            npm test
          displayName: Run tests
          env:
            IMAGE: ${{ variables.containerRegistry }}/${{ variables.applicationname }}
            TAG: $(Build.BuildNumber)

[mmarkelov]

@simonauner thank you for your issue and your workaround. I'll try to investigate this. Maybe there is a place where we didn’t close playwright

[simonauner]

@mmarkelov I think playwright might be closing alright, but a docker run won't close down when receiving SIGTERM (as far as my gooling made me understand at least), so it will just stick around.

[mmarkelov]

@simonauner it can be a problem, but i'll try to reproduce it locally and find out the problem

[mmarkelov]

@simonauner this was related to jest-process-manager. I just created PR to add ability to execute teardown command. After it will be merged i need to make some changes to jest-playwright and you will be able to use it like this:

// jest-playwright.config.js
module.exports = {
	...
	serverOptions: {
		command: `docker run --publish 3000:3000 --name Test node-docker`,
		teardown: `docker stop Test`,
		port: 3000,
	},
}

[simonauner]

@mmarkelov That's awesome! Thanks for that quick implementation! 👏

[mmarkelov]

Should worked in 1.5.2

[thernstig]

Was there a reason globalTeardown https://jestjs.io/docs/configuration#globalteardown-string from Jest could not be used? That is what we use to tear down things after tests. It feels weird having duplicated logic for this in jest-playwright. And it gets into the gray areas in how these two interact if both are used.