Back to Repositories

Validating User Model Authentication and Relationships in Postal

This test suite thoroughly validates the User model functionality in the Postal application, covering core user attributes, authentication, and organizational relationships. The tests ensure proper data validation, user permissions, and model relationships essential for the email delivery system.

Test Coverage Overview

The test suite provides comprehensive coverage of the User model’s core functionality:

User attribute validations including email format and password requirements
Organization relationships and admin access controls
UUID generation and timezone defaults
User identification and display methods

Implementation Analysis

The testing approach utilizes RSpec’s behavior-driven development patterns with factory-based test data generation. The implementation leverages RSpec’s expectation syntax and shared examples for validation testing, while incorporating custom matchers for relationship verification.

Technical Details

Key technical components include:

RSpec as the testing framework
Factory Bot for test data generation
Shoulda Matchers for validation testing
Database schema annotations for model documentation
Custom configuration mocking for OIDC testing

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Contextual organization of related tests
Comprehensive validation coverage
Edge case handling for authentication scenarios
Clear test descriptions and expectations
Proper isolation of test scenarios

postalserver/postal

spec/models/user_spec.rb

            
# frozen_string_literal: true

# == Schema Information
#
# Table name: users
#
#  id                               :integer          not null, primary key
#  admin                            :boolean          default(FALSE)
#  email_address                    :string(255)
#  email_verification_token         :string(255)
#  email_verified_at                :datetime
#  first_name                       :string(255)
#  last_name                        :string(255)
#  oidc_issuer                      :string(255)
#  oidc_uid                         :string(255)
#  password_digest                  :string(255)
#  password_reset_token             :string(255)
#  password_reset_token_valid_until :datetime
#  time_zone                        :string(255)
#  uuid                             :string(255)
#  created_at                       :datetime
#  updated_at                       :datetime
#
# Indexes
#
#  index_users_on_email_address  (email_address)
#  index_users_on_uuid           (uuid)
#
require "rails_helper"

describe User do
  subject(:user) { build(:user) }

  describe "validations" do
    it { is_expected.to validate_presence_of(:first_name) }
    it { is_expected.to validate_presence_of(:last_name) }
    it { is_expected.to validate_presence_of(:email_address) }
    it { is_expected.to validate_presence_of(:password) }
    it { is_expected.to validate_uniqueness_of(:email_address).case_insensitive }
    it { is_expected.to allow_value("[email protected]").for(:email_address) }
    it { is_expected.to allow_value("[email protected]").for(:email_address) }
    it { is_expected.to allow_value("[email protected]").for(:email_address) }
    it { is_expected.to allow_value("[email protected]").for(:email_address) }
    it { is_expected.to_not allow_value("test+tagged").for(:email_address) }
    it { is_expected.to_not allow_value("test.com").for(:email_address) }

    it "does not require a password when OIDC is enabled" do
      allow(Postal::Config.oidc).to receive(:enabled?).and_return(true)
      user.password = nil
      expect(user.save).to be true
    end
  end

  describe "relationships" do
    it { is_expected.to have_many(:organization_users) }
    it { is_expected.to have_many(:organizations) }
  end

  describe "creation" do
    before { user.save }

    it "should have a UUID" do
      expect(user.uuid).to be_a String
      expect(user.uuid.length).to eq 36
    end

    it "has a default timezone" do
      expect(user.time_zone).to eq "UTC"
    end
  end

  describe "#organizations_scope" do
    context "when the user is an admin" do
      it "returns a scope of all organizations" do
        user.admin = true
        scope = user.organizations_scope
        expect(scope).to eq Organization.present
      end
    end

    context "when the user not an admin" do
      it "returns a scope including only orgs the user is associated with" do
        user.admin = false
        user.organizations << create(:organization)
        scope = user.organizations_scope
        expect(scope).to eq user.organizations.present
      end
    end
  end

  describe "#name" do
    it "returns the name" do
      user.first_name = "John"
      user.last_name = "Doe"
      expect(user.name).to eq "John Doe"
    end
  end

  describe "#password?" do
    it "returns true if the user has a password" do
      user.password = "password"
      expect(user.password?).to be true
    end

    it "returns false if the user does not have a password" do
      user.password = nil
      expect(user.password?).to be false
    end
  end

  describe "#to_param" do
    it "returns the UUID" do
      user.uuid = "123"
      expect(user.to_param).to eq "123"
    end
  end

  describe "#email_tag" do
    it "returns the name and email address" do
      user.first_name = "John"
      user.last_name = "Doe"
      user.email_address = "[email protected]"
      expect(user.email_tag).to eq "John Doe <[email protected]>"
    end
  end

  describe ".[]" do
    it "should find a user by email address" do
      user = create(:user)
      expect(User[user.email_address]).to eq user
    end
  end
end