DEV Community: Amit Singh Bisht

Registed a runner in Github

Amit Singh Bisht — Thu, 05 Jun 2025 14:17:19 +0000

How to register a runner ?

Download

# Create a folder
$ mkdir actions-runner && cd actions-runnerCopied! 

# Download the latest runner package
$ curl -o actions-runner-linux-x64-2.325.0.tar.gz -L https://github.com/actions/runner/releases/download/v2.325.0/actions-runner-linux-x64-2.325.0.tar.gz

# Optional: Validate the hash
$ echo "5020xxxxxxd85cxx6059xxxxe0de8fxxx753xxxx9x558exxxxxxd43exex518xx  actions-runner-linux-x64-2.325.0.tar.gz" | shasum -a 256 -c

# Extract the installer
$ tar xzf ./actions-runner-linux-x64-2.325.0.tar.gz

Configure

# Create the runner and start the configuration experience
$ ./config.sh --url https://github.com/amit-singh-bisht/lambda-playwright --token AxxxFxxxJ4xxx5BxxxEBxxxIIxxxx

# Last step, run it!
$ ./run.sh

Using your self-hosted runner

# Use this YAML in your workflow file for each job
runs-on: self-hosted

Start a instance on EC2

npm init playwright

Amit Singh Bisht — Mon, 02 Jun 2025 09:23:38 +0000

If you’re starting with Playwright for end-to-end testing, you’ll quickly encounter the playwright.config.ts file. This file is the backbone of your Playwright test setup, controlling how tests run, which browsers are used, and much more.

In this article, I’ll walk you through a typical Playwright configuration file, explaining every line—including the commented ones—so you’ll know exactly what’s happening and how to customize it for your own projects.

import { defineConfig, devices } from '@playwright/test';
import dotenv from 'dotenv';
import path from 'path';
dotenv.config({ path: path.resolve(__dirname, '.env') });

/**
 * See https://playwright.dev/docs/test-configuration.
 */
export default defineConfig({
  testDir: './tests',
  /* Run tests in files in parallel */
  fullyParallel: true,
  /* Fail the build on CI if you accidentally left test.only in the source code. */
  forbidOnly: !!process.env.CI,
  /* Retry on CI only */
  retries: process.env.CI ? 2 : 0,
  /* Opt out of parallel tests on CI. */
  workers: process.env.CI ? 1 : undefined,
  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
  reporter: 'html',
  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
  use: {
    /* Base URL to use in actions like `await page.goto('/')`. */
    // baseURL: 'http://localhost:3000',

    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
    trace: 'on-first-retry',
  },

  /* Configure projects for major browsers */
  projects: [
    {
      name: 'chromium',
      use: { ...devices['Desktop Chrome'] },
    },

    {
      name: 'firefox',
      use: { ...devices['Desktop Firefox'] },
    },

    {
      name: 'webkit',
      use: { ...devices['Desktop Safari'] },
    },

    /* Test against mobile viewports. */
    // {
    //   name: 'Mobile Chrome',
    //   use: { ...devices['Pixel 5'] },
    // },
    // {
    //   name: 'Mobile Safari',
    //   use: { ...devices['iPhone 12'] },
    // },

    /* Test against branded browsers. */
    // {
    //   name: 'Microsoft Edge',
    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
    // },
    // {
    //   name: 'Google Chrome',
    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
    // },
  ],

  /* Run your local dev server before starting the tests */
  // webServer: {
  //   command: 'npm run start',
  //   url: 'http://localhost:3000',
  //   reuseExistingServer: !process.env.CI,
  // },
});

Breaking Down the Configuration

Let’s go through the file, section by section.

Imports and Environment Variables

import { defineConfig, devices } from '@playwright/test';
import dotenv from 'dotenv';
import path from 'path';
dotenv.config({ path: path.resolve(__dirname, '.env') });

defineConfig, devices: These come from Playwright. defineConfig helps with type safety and autocompletion. devices provides pre-configured settings for various browsers and devices.
dotenv, path: These are Node.js packages. dotenv loads environment variables from a .env file, and path helps resolve the file path.
dotenv.config(...): Loads environment variables from .env so you can use them in your tests or config.

DefineConfig

export default defineConfig({
  testDir: './tests',
  fullyParallel: true,
  forbidOnly: !!process.env.CI,
  retries: process.env.CI ? 2 : 0,
  workers: process.env.CI ? 1 : undefined,
  reporter: 'html',
});

What do these options mean?

testDir: Where your test files live. Change this if your tests are in a different folder.
fullyParallel: Run tests in different files at the same time for speed.
forbidOnly: If you accidentally leave a test.only in your code, this will fail the build on CI to prevent running only a subset of tests.
retries: How many times to retry a failing test. Retries twice on CI, never locally.
workers: Number of parallel workers. On CI, runs tests serially (1 worker) for stability; locally, uses the default (parallel).
reporter: Generates an HTML report of your test results.

use: Shared settings for all tests.

use: {
  // baseURL: 'http://localhost:3000',
  trace: 'on-first-retry',
}

What does this do?

baseURL: (commented) If you have a local server, set this so you can use relative URLs in your tests.
trace: Collects a trace (detailed log) only when a test fails and is retried.

projects: Lets you run the same tests in different browsers and devices.

projects: [
  {
    name: 'chromium',
    use: { ...devices['Desktop Chrome'] },
  },
  {
    name: 'firefox',
    use: { ...devices['Desktop Firefox'] },
  },
  {
    name: 'webkit',
    use: { ...devices['Desktop Safari'] },
  },
  // Mobile and branded browsers (commented out)
]

chromium: Runs tests in Google Chrome.
firefox: Runs tests in Mozilla Firefox.
webkit: Runs tests in Safari.
Mobile and branded browsers: You can uncomment these to test on mobile devices (like Pixel 5 or iPhone 12) or branded browsers (like Edge or Chrome with specific channels).

Running a Local Dev Server (Optional)

If you have a local server running, you can uncomment this to start it before running tests.

webServer: {
  command: 'npm run start',
  url: 'http://localhost:3000',
  reuseExistingServer: !process.env.CI,
}

command: The command to start your server.
url: The URL Playwright should wait for before running tests.
reuseExistingServer: Reuse the server if it’s already running (locally), but always start fresh on CI.

Customizing for Your Project

Change testDir if your tests are in a different folder.
Uncomment and set baseURL if you want to use relative URLs in your tests.
Add or remove projects to test on different browsers or devices.
Enable webServer if your app needs to be running for tests.

Conclusion

The Playwright configuration file is powerful but approachable. By understanding each line, you can tailor your test setup to your project’s needs, run tests across browsers and devices, and ensure your app works everywhere.
If you’re new to Playwright, start with the defaults, then experiment with the options as your project grows. Happy testing!

Maven Project Setup Guide

Amit Singh Bisht — Wed, 26 Jun 2024 05:32:27 +0000

Step-by-Step Guide to Creating a Maven Project

Using Maven Archetype
You can create a new Maven project by running the following command:

mvn archetype:generate

This command will prompt you to enter various details about your project and generate the pom.xml file. Below is an example interaction:

3444: remote -> za.co.absa.hyperdrive:component-archetype_2.12 (-)
Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains): 2155: 

If you press enter, it will select (2155: remote -> org.apache.maven.archetypes:maven-archetype-quickstart (An archetype which contains a sample Maven project.)

Choose org.apache.maven.archetypes:maven-archetype-quickstart version: 
1: 1.0-alpha-1
2: 1.0-alpha-2
3: 1.0-alpha-3
4: 1.0-alpha-4
5: 1.0
6: 1.1
7: 1.3
8: 1.4
Choose a number: 8: 

If you press enter, it will select (8: 1.4)

Define value for property 'groupId': com.example.project
Define value for property 'artifactId': my-app
Define value for property 'version' 1.0-SNAPSHOT: : 
Define value for property 'package' com.example.project: : com.example.project.myapp

(press enter or any value that you want)


REMEMBER :- groupId, artifactId, version, package can be changed at later stage as well

Confirm properties configuration:
groupId: com.example.project
artifactId: my-app
version: 1.0-SNAPSHOT
package: com.example.project.myapp
 Y: : (press enter)


[INFO] ----------------------------------------------------------------------------
[INFO] Using following parameters for creating project from Archetype: maven-archetype-quickstart:1.4
[INFO] ----------------------------------------------------------------------------
[INFO] Parameter: groupId, Value: com.example.project
[INFO] Parameter: artifactId, Value: my-app
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] Parameter: package, Value: com.example.project.myapp
[INFO] Parameter: packageInPathFormat, Value: com/example/project/myapp
[INFO] Parameter: package, Value: com.example.project.myapp
[INFO] Parameter: groupId, Value: com.example.project
[INFO] Parameter: artifactId, Value: my-app
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] Project created from Archetype in dir: /Users/amitb/Desktop/code/lambdatest/professional-services-java-cucumber/my-app
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  00:50 min
[INFO] Finished at: 2024-06-26T10:37:56+05:30
[INFO] ------------------------------------------------------------------------

Skipping the Questionnaire

To skip the interactive questionnaire and create a Maven project with one command, use:

mvn archetype:generate -DgroupId=com.example.project -DartifactId=my-app -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

Example output:

mvn archetype:generate -DgroupId=com.example.project -DartifactId=my-app -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

[INFO] Scanning for projects...
[INFO] 
[INFO] ------------------< org.apache.maven:standalone-pom >-------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] --------------------------------[ pom ]---------------------------------
[INFO] 
[INFO] >>> archetype:3.2.1:generate (default-cli) > generate-sources @ standalone-pom >>>
[INFO] 
[INFO] <<< archetype:3.2.1:generate (default-cli) < generate-sources @ standalone-pom <<<
[INFO] 
[INFO] 
[INFO] --- archetype:3.2.1:generate (default-cli) @ standalone-pom ---
[INFO] Generating project in Batch mode
[INFO] ----------------------------------------------------------------------------
[INFO] Using following parameters for creating project from Old (1.x) Archetype: maven-archetype-quickstart:1.0
[INFO] ----------------------------------------------------------------------------
[INFO] Parameter: basedir, Value: /Users/amitb
[INFO] Parameter: package, Value: com.example.project
[INFO] Parameter: groupId, Value: com.example.project
[INFO] Parameter: artifactId, Value: my-app
[INFO] Parameter: packageName, Value: com.example.project
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] project created from Old (1.x) Archetype in dir: /Users/amitb/my-app
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  2.300 s
[INFO] Finished at: 2024-06-26T10:43:15+05:30
[INFO] ------------------------------------------------------------------------

The pom.xml Structure

Main Block

The entire pom.xml is enclosed within the following tags:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 

</project>

Basic Properties

This block defines the most basic properties of the application:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

   <modelVersion>4.0.0</modelVersion>
   <groupId>com.example.project</groupId>
   <artifactId>my-app</artifactId>
   <version>0.1.0</version>
   <packaging>jar</packaging>
   <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <maven.compiler.source>1.8</maven.compiler.source>
      <maven.compiler.target>1.8</maven.compiler.target>
   </properties>

   [...]

</project>

Dependencies Block

For this project, I am importing the JDBC library for accessing SQLite databases:

    <dependencies>
        <!-- https://mvnrepository.com/artifact/org.xerial/sqlite-jdbc -->
        <dependency>
            <groupId>org.xerial</groupId>
            <artifactId>sqlite-jdbc</artifactId>
            <version>3.20.0</version>
        </dependency>
    </dependencies>

Key Points

groupId: A unique base name of your company or group.
artifactId: A unique name of the project you are developing.
version: The version of the project you are developing.
packaging: Type of artifact (e.g., jar, war).
dependencies: External libraries required for your project.

With this setup, you can easily manage dependencies and keep your project up to date with the latest versions.