Back to Repositories

Testing JavaScript Version Detection Configuration in WPScan

This test suite validates the JavascriptVar version finder functionality in WPScan, focusing on dynamic class creation and configuration handling. The tests ensure proper initialization of version detection patterns and configuration parameters for JavaScript-based version discovery.

Test Coverage Overview

The test suite provides comprehensive coverage of the JavascriptVar version finder implementation.

Tests dynamic class creation with various configuration combinations
Validates pattern matching and version extraction capabilities
Covers default configuration fallbacks
Verifies xpath and confidence level handling

Implementation Analysis

The testing approach utilizes RSpec’s module and class manipulation features to validate dynamic finder behavior.

Tests employ before/after hooks for class creation and cleanup, with detailed constant verification across multiple configuration scenarios. The implementation leverages RSpec’s context blocks for organized test case separation.

Technical Details

RSpec testing framework with module mocking
Dynamic class generation and constant verification
XPath pattern testing for JavaScript content
Configuration parameter validation
Module cleanup through constant removal

Best Practices Demonstrated

The test suite exemplifies several testing best practices including proper test isolation and setup/teardown management.

Consistent context organization
Clear test case separation
Proper cleanup of test artifacts
Comprehensive edge case coverage
Modular test structure

wpscanteam/wpscan

spec/lib/finders/dynamic_finder/version/javascript_var_spec.rb

            
# frozen_string_literal: true

describe WPScan::Finders::DynamicFinder::Version::JavascriptVar do
  module WPScan
    module Finders
      module Version
        # Needed to be able to test the below
        module Rspec
        end
      end
    end
  end

  let(:finder_module) { WPScan::Finders::Version::Rspec }
  let(:finder_class)  { WPScan::Finders::Version::Rspec::JavascriptVar }
  let(:finder_config) { { 'pattern' => /some version: (?<v>[\d.]+)/i } }
  let(:default)       { { 'xpath' => '//script[not(@src)]', 'confidence' => 60 } }

  before { described_class.create_child_class(finder_module, :JavascriptVar, finder_config) }
  after  { finder_module.send(:remove_const, :JavascriptVar) }

  describe '.create_child_class' do
    context 'when no PATH and CONFIDENCE' do
      it 'contains the expected constants to their default values' do
        # Doesn't work, dunno why
        # expect(finder_module.const_get(:JavascriptVar)).to be_a described_class
        # expect(finder_class.is_a?(described_class)).to eql true
        # expect(finder_class).to be_a described_class

        expect(finder_class::PATTERN).to eql finder_config['pattern']

        expect(finder_class::XPATH).to eql default['xpath']
        expect(finder_class::CONFIDENCE).to eql default['confidence']
        expect(finder_class::PATH).to eql nil
      end
    end

    context 'when CONFIDENCE' do
      let(:finder_config) { super().merge('confidence' => 30) }

      it 'contains the expected constants' do
        expect(finder_class::PATTERN).to eql finder_config['pattern']
        expect(finder_class::CONFIDENCE).to eql finder_config['confidence']

        expect(finder_class::XPATH).to eql default['xpath']
        expect(finder_class::PATH).to eql nil
      end
    end

    context 'when PATH' do
      let(:finder_config) { super().merge('path' => 'file.html') }

      it 'contains the expected constants' do
        expect(finder_class::PATTERN).to eql finder_config['pattern']
        expect(finder_class::PATH).to eql finder_config['path']

        expect(finder_class::CONFIDENCE).to eql default['confidence']
        expect(finder_class::XPATH).to eql default['xpath']
      end
    end

    context 'when XPATH' do
      let(:finder_config) { super().merge('xpath' => '//script') }

      it 'contains the expected constants' do
        expect(finder_class::PATTERN).to eql finder_config['pattern']
        expect(finder_class::XPATH).to eql finder_config['xpath']

        expect(finder_class::PATH).to eql nil
        expect(finder_class::CONFIDENCE).to eql default['confidence']
      end
    end
  end

  describe '#passive, #aggressive' do
    # Handled in spec/lib/finders/dynamic_finder/plugin_version_spec
  end
end