Pest PHP Session validation test failing at GitHub Actions but works locally.

I have a Pest automated test that checks to see if the minimum characters are 8 when doing the stock Laravel password reset. I had to implement this because I discovered in legacy code that the code Fortify has for PasswordValidationRules is failing on some websites because it was never updated.

When I run this test locally, it works. When I push the code to GitHub where it triggers a workflow action, the test fails.

The error at GitHub is:

Session missing error: password

Is session validation testing possible using GitHub Actions? What might I be missing?

Here is the test:


it('it gives an error message if the password reset is of the incorrect length', function () {
    // The notification faking is required to get the password reset token.
    Notification::fake();

    // Create a test user
    $user = User::factory()->create([
        'email' => '[email protected]',
        'password' => Hash::make('old_password'), // Set an old password
    ]);

    // Trigger the forgot password process to generate a token
    $this->post(route('password.email'), [
        'email' => '[email protected]',
    ]);

    // Capture the token sent to the user
    Notification::assertSentTo($user, ResetPassword::class, function ($notification) use ($user, &$token) {
        $token = $notification->token; // Save the token
        return true;
    });

    // Submit the password reset form with an  incorrect number of characters
    $response = $this->post(route('password.update'), [
        'token' => $token,
        'email' => '[email protected]',
        'password' => '1234567',
        'password_confirmation' => '1234567',
    ]);

    // Assert session has an error for the password field
    $response->assertSessionHasErrors('password');
});

Here is the GitHub Actions yml:

name: tests

on:
  push:
  pull_request:

jobs:
  tests:
    runs-on: ubuntu-24.04

    strategy:
      fail-fast: true
      matrix:
        php: ['8.2']
        laravel: [11]

    name: PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }}
    env:
      DB_DATABASE: laravel
      DB_USERNAME: root
      DB_PASSWORD: password
      NOVA_USERNAME: ${{ secrets.NOVA_USERNAME }}
      NOVA_LICENSE_KEY: ${{ secrets.NOVA_LICENSE_KEY }}

    # See https://github.com/shivammathur/setup-php/blob/master/examples/laravel-mysql.yml
    # Docs: https://docs.github.com/en/actions/using-containerized-services
    # Had to include DB_PORT for last test
    services:
      mysql:
        image: mysql:latest
        env:
          MYSQL_ALLOW_EMPTY_PASSWORD: false
          MYSQL_ROOT_PASSWORD: password
          MYSQL_DATABASE: laravel
        ports:
          - 3306/tcp
        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: ${{ matrix.php }}
          extensions: dom, curl, libxml, mbstring, zip, bcmath
          ini-values: error_reporting=E_ALL
          tools: composer:v2
          coverage: none

      - name: Install dependencies
        run: |
          composer require "illuminate/contracts=^${{ matrix.laravel }}" --no-update
          composer update --prefer-dist --no-interaction --no-progress

      - name: Prepare Laravel Application
        run: |
          cp .env.ci .env
          php artisan key:generate

      - name: Execute tests
        run: vendor/bin/pest
        env:
          DB_PORT: ${{ job.services.mysql.ports['3306'] }}

LaryAI

1 year ago

Level 58

The issue you're encountering is likely due to differences in the environment between your local machine and the GitHub Actions runner. Here are a few steps to troubleshoot and potentially resolve the issue:

Ensure Database Migrations and Seeders are Run: Make sure that your database is properly set up before running the tests. This includes running migrations and possibly seeding the database.
Check for Missing Environment Variables: Ensure that all necessary environment variables are set correctly in your GitHub Actions workflow.
Session Configuration: Ensure that the session is properly configured and that the session driver is set to file or another appropriate driver that works in the GitHub Actions environment.
Debugging: Add some debugging steps to your GitHub Actions workflow to output the state of the application and the database.

Here is an updated version of your GitHub Actions workflow with additional steps to ensure the database is set up correctly and to add some debugging information:

name: tests

on:
  push:
  pull_request:

jobs:
  tests:
    runs-on: ubuntu-24.04

    strategy:
      fail-fast: true
      matrix:
        php: ['8.2']
        laravel: [11]

    name: PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }}
    env:
      DB_DATABASE: laravel
      DB_USERNAME: root
      DB_PASSWORD: password
      NOVA_USERNAME: ${{ secrets.NOVA_USERNAME }}
      NOVA_LICENSE_KEY: ${{ secrets.NOVA_LICENSE_KEY }}

    services:
      mysql:
        image: mysql:latest
        env:
          MYSQL_ALLOW_EMPTY_PASSWORD: false
          MYSQL_ROOT_PASSWORD: password
          MYSQL_DATABASE: laravel
        ports:
          - 3306/tcp
        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: ${{ matrix.php }}
          extensions: dom, curl, libxml, mbstring, zip, bcmath
          ini-values: error_reporting=E_ALL
          tools: composer:v2
          coverage: none

      - name: Install dependencies
        run: |
          composer require "illuminate/contracts=^${{ matrix.laravel }}" --no-update
          composer update --prefer-dist --no-interaction --no-progress

      - name: Prepare Laravel Application
        run: |
          cp .env.ci .env
          php artisan key:generate
          php artisan migrate --force
          php artisan db:seed --force

      - name: Debugging: List database tables
        run: |
          mysql -u root -ppassword -e 'SHOW TABLES;' laravel

      - name: Execute tests
        run: vendor/bin/pest
        env:
          DB_PORT: ${{ job.services.mysql.ports['3306'] }}

Explanation:

Database Migrations and Seeders:
- Added php artisan migrate --force and php artisan db:seed --force to ensure the database is properly set up before running the tests.
Debugging:
- Added a step to list the database tables to ensure the database is correctly set up and accessible.

Additional Tips:

Session Configuration: Ensure that your config/session.php is properly configured for the GitHub Actions environment. You might want to set the session driver to file for simplicity.
Environment Variables: Double-check that all necessary environment variables are set correctly in your .env.ci file.

By following these steps, you should be able to identify and resolve the issue causing the test to fail in the GitHub Actions environment.

eugenefvdm

1 year ago

Level 31

Well I'm not going to lie when I say the AI advice made me think.

First of all, I never considered I might have to use a file driver.

Secondly, I thought it interesting to give me an updated ci file that does forced migrations and seeders. Although in retrospect then why should I use file in the first place? I have no other confirmed information that GitHub Actions needs a file driver. Anyway I tried that and it didn't work.

But the advice gave me a chance to review many other things, including if I should maybe publish the session.php file and play with it's defaults. This didn't help either.

In the end I spent maybe another hour of troubleshooting.

This was my solution in the end, just exclude the damn thing.

})->group('excluded-at-github-actions');

And then

      - name: Execute tests
        run: vendor/bin/pest --exclude-group=excluded-at-github-actions

Please or to participate in this conversation.