Back to Repositories

Testing Aliases Controller CLI Options in WPScan

This test suite verifies the functionality of the Aliases controller in WPScan, focusing on CLI options handling and stealth mode configuration. The tests ensure proper parsing and application of command-line arguments, particularly for stealth-related features.

Test Coverage Overview

The test suite provides comprehensive coverage of the WPScan Aliases controller functionality, specifically targeting CLI options processing and stealth mode behavior.

Validates CLI options structure and content
Tests stealth mode parameter handling
Verifies detection mode configurations
Ensures proper user agent randomization

Implementation Analysis

The testing approach utilizes RSpec’s behavior-driven development patterns with subject/let declarations for clean test setup.

Implements context-based test organization
Uses RSpec’s expectation syntax for assertions
Leverages before hooks for test state setup
Employs subject/let patterns for DRY test code

Technical Details

RSpec testing framework
WPScan::Controller::Aliases implementation
CLI argument parsing system
Detection mode configuration
User agent handling

Best Practices Demonstrated

The test suite exemplifies several testing best practices in Ruby and RSpec.

Isolated test contexts for different scenarios
Clear test case organization
Descriptive context and example naming
Proper setup and teardown management
Effective use of RSpec matchers

wpscanteam/wpscan

spec/app/controllers/aliases_spec.rb

            
# frozen_string_literal: true

describe WPScan::Controller::Aliases do
  subject(:controller) { described_class.new }
  let(:target_url)     { 'http://ex.lo/' }
  let(:cli_args)       { "--url #{target_url}" }

  before do
    WPScan::ParsedCli.options = rspec_parsed_options(cli_args)
  end

  describe '#cli_options' do
    its(:cli_options) { should_not be_empty }
    its(:cli_options) { should be_a Array }

    it 'contains to correct options' do
      expect(controller.cli_options.map(&:to_sym)).to eq %i[stealthy]
    end
  end

  describe 'parsed_options' do
    context 'when no --stealthy supplied' do
      it 'contains the correct options' do
        expect(WPScan::ParsedCli.options).to include(
          detection_mode: :mixed, plugins_version_detection: :mixed
        )
      end
    end

    context 'when --stealthy supplied' do
      let(:cli_args) { "#{super()} --stealthy" }

      it 'contains the correct options' do
        expect(WPScan::ParsedCli.options).to include(
          random_user_agent: true, detection_mode: :passive, plugins_version_detection: :passive
        )
      end
    end
  end
end