Showing posts with label Basic Authentication in Playwright. Show all posts
Showing posts with label Basic Authentication in Playwright. Show all posts

Test Basic Authentication in API by Playwright























What Is Basic Authentication? Complete Guide to Handling Basic Authentication in Playwright Java

In modern web applications and APIs, authentication plays a critical role in protecting sensitive data and restricting unauthorized access. One of the simplest and oldest authentication mechanisms used in web applications is Basic Authentication.

If you are working with automation testing using Playwright Java, understanding how to handle Basic Authentication efficiently is essential. In this detailed, SEO-optimized, and beginner-friendly guide, you will learn:

  • What Basic Authentication is

  • How it works behind the scenes

  • Where it is commonly used

  • How Playwright Java handles Basic Authentication

  • Step-by-step implementation with real example

  • Best practices and security considerations

This article is written in a clear, human tone and structured for easy understanding.


What Is Basic Authentication?

Basic Authentication is a simple authentication method used to verify a user’s identity using a username and password.

When a user tries to access a protected resource:

  1. The server asks for credentials.

  2. The client sends the username and password.

  3. The server validates the credentials.

  4. If valid, access is granted.

In technical terms, Basic Authentication works using the HTTP Authorization header.

How It Works Internally

When a user provides:

  • Username: user

  • Password: passwd

The browser combines them like this:

user:passwd

This string is encoded using Base64 and sent to the server in the HTTP header:

Authorization: Basic dXNlcjpwYXNzd2Q=

If the credentials are correct, the server responds with:

200 OK

If incorrect, the server responds with:

401 Unauthorized


Where Is Basic Authentication Used?

Basic Authentication is commonly used in:

  • Internal applications

  • Testing environments

  • Staging servers

  • Lightweight APIs

  • Admin panels

It is simple to implement and works well over HTTPS.

However, it is not recommended for highly sensitive production systems without additional security layers.


Why Is Basic Authentication Important in Automation Testing?

When performing automation testing:

  • Some web pages require login before access.

  • Some APIs require authentication headers.

  • Some staging servers use basic authentication as a protection layer.

If your automation framework cannot handle authentication properly, your tests will fail before even interacting with the application.

That’s where Playwright Java makes things easy.


How Playwright Java Handles Basic Authentication

Playwright provides a clean and centralized way to manage Basic Authentication.

Instead of manually adding the Authorization header in every request, Playwright allows you to configure credentials at the BrowserContext level.


What Is a BrowserContext in Playwright?

A BrowserContext in Playwright is like an isolated browser profile.

Each context:

  • Has its own cookies

  • Has its own session storage

  • Has its own authentication configuration

When you configure HTTP credentials inside a BrowserContext:

  • Every request automatically includes the authentication header.

  • You do not need to handle credentials repeatedly.

  • All pages, frames, and API calls inside that context inherit authentication.


Advantages of Using BrowserContext for Basic Authentication

1. Centralized Credential Handling

You define credentials once and reuse them across the entire test session.


2. No Manual Header Management

You don’t need to manually write:

Authorization: Basic <encoded-value>

Playwright handles it internally.


3. Works Across Pages and API Calls

Authentication automatically applies to:

  • Page navigation

  • Frame loading

  • API calls

  • AJAX requests


4. Cleaner and Maintainable Code

Credentials are not scattered across multiple test methods.


Step-by-Step: Testing Basic Authentication in Playwright Java

We will use the test website:

httpbin

Specifically, the URL:

https://httpbin.org/basic-auth/user/passwd

This endpoint requires:

  • Username: user

  • Password: passwd

If authentication is successful, it returns:

{ "authenticated": true, "user": "user" }


Complete Playwright Java Code Example

Below is the working Java example to test Basic Authentication.

import com.microsoft.playwright.*; public class BasicAuthTest { public static void main(String[] args) { try (Playwright playwright = Playwright.create()) { // Launch browser Browser browser = playwright.chromium() .launch(new BrowserType.LaunchOptions().setHeadless(false)); // Configure HTTP Basic Authentication credentials Browser.NewContextOptions contextOptions = new Browser.NewContextOptions() .setHttpCredentials("user", "passwd"); // Create a new browser context with credentials BrowserContext context = browser.newContext(contextOptions); // Open a new page Page page = context.newPage(); // Navigate to protected URL page.navigate("https://httpbin.org/basic-auth/user/passwd"); // Verify authentication String bodyText = page.textContent("body"); if (bodyText.contains("\"authenticated\": true")) { System.out.println("Basic authentication successful!"); } else { System.out.println("Basic authentication failed."); } browser.close(); } } }


Code Explanation (Step-by-Step)

Let’s break it down clearly.


Step 1: Create Playwright Instance

Playwright playwright = Playwright.create();

This initializes the Playwright engine.


Step 2: Launch Browser

Browser browser = playwright.chromium().launch(...);

We launch the Chromium browser.

setHeadless(false) allows us to visually see the browser.
In CI environments, you can set it to true.


Step 3: Set HTTP Credentials

.setHttpCredentials("user", "passwd");

This is the most important step.

Instead of manually encoding credentials, Playwright does it internally.


Step 4: Create BrowserContext with Credentials

BrowserContext context = browser.newContext(contextOptions);

All pages created inside this context will automatically use authentication.


Step 5: Create Page Object

Page page = context.newPage();

Represents a browser tab.


Step 6: Navigate to Protected URL

page.navigate("https://httpbin.org/basic-auth/user/passwd");

Because credentials are already configured, Playwright automatically sends the Authorization header.


Step 7: Validate Authentication

bodyText.contains("\"authenticated\": true")

If authentication succeeds, the page contains:

"authenticated": true


Expected Output

Basic authentication successful!

This confirms that:

  • Credentials were sent correctly

  • Server validated them

  • Access was granted


Maven Dependency

Add this dependency in your pom.xml:

<dependency> <groupId>com.microsoft.playwright</groupId> <artifactId>playwright</artifactId> <version>1.44.0</version> </dependency>

Make sure Playwright browsers are installed using:

mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install"


Handling Basic Authentication in API Testing

Playwright also supports API testing via APIRequestContext.

Example:

APIRequestContext request = playwright.request().newContext( new APIRequest.NewContextOptions() .setHttpCredentials("user", "passwd") );

Now all API requests from this context will include Basic Authentication.

This is extremely useful for:

  • REST API automation

  • Backend validation

  • Microservices testing


Security Considerations for Basic Authentication

While Basic Authentication is simple, it has limitations.

1. Always Use HTTPS

Basic Authentication sends credentials encoded in Base64.

Base64 is not encryption.

If sent over HTTP, credentials can be intercepted.

Always use HTTPS.


2. Avoid Hardcoding Credentials

Instead of:

.setHttpCredentials("user", "passwd")

Use environment variables:

System.getenv("USERNAME")

This improves security in CI/CD pipelines.


3. Rotate Credentials Regularly

Especially in shared test environments.


Common Mistakes in Basic Authentication Testing

  1. Forgetting HTTPS

  2. Adding manual Authorization headers unnecessarily

  3. Hardcoding credentials in test files

  4. Using wrong context for multiple tests

  5. Not isolating sessions properly


When Should You Use Basic Authentication in Automation?

Basic Authentication is ideal for:

  • Protecting staging environments

  • Securing test APIs

  • Internal dashboards

  • Quick login-based testing

However, modern applications often use:

  • Token-based authentication (JWT)

  • OAuth 2.0

  • Cookie-based sessions

But for simple authentication scenarios, Basic Authentication remains very effective.


Best Practices for Playwright Java Authentication

Use Dedicated Authentication Context

Create a reusable method:

public static BrowserContext createAuthenticatedContext(...) { }


Separate Credentials from Test Logic

Store in:

  • .env files

  • CI secrets

  • Configuration files


Use Headless Mode in CI

For performance and faster test execution.


Final Thoughts

Basic Authentication is one of the simplest and most widely used authentication mechanisms in web applications and APIs. While it may not be suitable for complex production environments, it remains highly useful in test environments and internal applications.

With Playwright Java, handling Basic Authentication is extremely simple and elegant. By configuring credentials at the BrowserContext level, you ensure:

  • Clean test architecture

  • Centralized credential management

  • Automatic header handling

  • Secure implementation

If you are building a scalable automation framework, mastering authentication handling in Playwright Java is essential.



Suggested Posts:

1. Automate GET API in Playwright
2. Automate POST API in Playwright
3. Automate PUT API in Playwright
4. Test Cookie Based Authentication in Playwright
5. Token Bsed Authentication in Playwright