From 70ae42ac65ea43952667c7ed7728620370388acf Mon Sep 17 00:00:00 2001 From: Skylar Bolton Date: Sat, 24 May 2025 17:38:26 -0400 Subject: [PATCH 1/3] feat: Fix settings not saving CLAUDE, says this is the issue. Will add tests --- options.php | 34 +++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/options.php b/options.php index 6288a4e..bce56c6 100644 --- a/options.php +++ b/options.php @@ -253,18 +253,42 @@ public function page_init() { * @param array $input Contains all settings fields as array keys */ public function sanitize( $input ) { - foreach( ['scss_dir', 'css_dir'] as $dir ){ + $new_input = array(); + + // Sanitize directory paths + foreach( ['scss_dir', 'css_dir', 'cache_dir'] as $dir ){ if( !empty( $input[$dir] ) ) { - $input[$dir] = sanitize_text_field( $input[$dir] ); + $new_input[$dir] = sanitize_text_field( $input[$dir] ); // Add a trailing slash if not already present - if(substr($input[$dir], -1) != '/'){ - $input[$dir] .= '/'; + if(substr($new_input[$dir], -1) != '/'){ + $new_input[$dir] .= '/'; } } } - return $input; + // Sanitize other text fields + if( !empty( $input['base_compiling_folder'] ) ) { + $new_input['base_compiling_folder'] = sanitize_text_field( $input['base_compiling_folder'] ); + } + + if( !empty( $input['compiling_options'] ) ) { + $new_input['compiling_options'] = sanitize_text_field( $input['compiling_options'] ); + } + + if( !empty( $input['sourcemap_options'] ) ) { + $new_input['sourcemap_options'] = sanitize_text_field( $input['sourcemap_options'] ); + } + + if( !empty( $input['errors'] ) ) { + $new_input['errors'] = sanitize_text_field( $input['errors'] ); + } + + // Sanitize checkbox fields + $new_input['enqueue'] = !empty( $input['enqueue'] ) ? '1' : '0'; + $new_input['always_recompile'] = !empty( $input['always_recompile'] ) ? '1' : '0'; + + return $new_input; } /** From 32f3f61fcd0c5171336e3597c11aaefb781c1746 Mon Sep 17 00:00:00 2001 From: Skylar Bolton Date: Sat, 24 May 2025 17:40:15 -0400 Subject: [PATCH 2/3] chore: Adding some tests to the system --- bin/install-wp-tests.sh | 147 +++++++++++++++++++ phpunit.xml | 18 +++ tests/bootstrap.php | 30 ++++ tests/test-settings.php | 190 +++++++++++++++++++++++++ tests/test-wp-scss-integration.php | 219 +++++++++++++++++++++++++++++ 5 files changed, 604 insertions(+) create mode 100644 bin/install-wp-tests.sh create mode 100644 phpunit.xml create mode 100644 tests/bootstrap.php create mode 100644 tests/test-settings.php create mode 100644 tests/test-wp-scss-integration.php diff --git a/bin/install-wp-tests.sh b/bin/install-wp-tests.sh new file mode 100644 index 0000000..a4a2fcf --- /dev/null +++ b/bin/install-wp-tests.sh @@ -0,0 +1,147 @@ +#!/usr/bin/env bash + +if [ $# -lt 3 ]; then + echo "usage: $0 [db-host] [wp-version] [skip-database-creation]" + exit 1 +fi + +DB_NAME=$1 +DB_USER=$2 +DB_PASS=$3 +DB_HOST=${4-localhost} +WP_VERSION=${5-latest} +SKIP_DB_CREATE=${6-false} + +TMPDIR=${TMPDIR-/tmp} +TMPDIR=$(echo $TMPDIR | sed -e "s/\/$//") +WP_TESTS_DIR=${WP_TESTS_DIR-$TMPDIR/wordpress-tests-lib} +WP_CORE_DIR=${WP_CORE_DIR-$TMPDIR/wordpress/} + +download() { + if [ `which curl` ]; then + curl -s "$1" > "$2"; + elif [ `which wget` ]; then + wget -nv -O "$2" "$1" + fi +} + +if [[ $WP_VERSION =~ ^[0-9]+\.[0-9]+$ ]]; then + WP_TESTS_TAG="branches/$WP_VERSION" +elif [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0-9]+ ]]; then + if [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0] ]]; then + # version x.x.0 means the first release of the major version, so strip off the .0 and download version x.x + WP_TESTS_TAG="tags/${WP_VERSION%??}" + else + WP_TESTS_TAG="tags/$WP_VERSION" + fi +elif [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then + WP_TESTS_TAG="trunk" +else + # http serves a single offer, whereas https serves multiple. we only want one + download http://api.wordpress.org/core/version-check/1.7/ /tmp/wp-latest.json + grep '[0-9]+\.[0-9]+(\.[0-9]+)?' /tmp/wp-latest.json + LATEST_VERSION=$(grep -o '"version":"[^"]*' /tmp/wp-latest.json | sed 's/"version":"//') + if [[ -z "$LATEST_VERSION" ]]; then + echo "Latest WordPress version could not be found" + exit 1 + fi + WP_TESTS_TAG="tags/$LATEST_VERSION" +fi + +set -ex + +install_wp() { + + if [ -d $WP_CORE_DIR ]; then + return; + fi + + mkdir -p $WP_CORE_DIR + + if [[ $WP_VERSION == 'nightly' || $WP_VERSION == 'trunk' ]]; then + mkdir -p $TMPDIR/wordpress-nightly + download https://wordpress.org/nightly-builds/wordpress-latest.zip $TMPDIR/wordpress-nightly/wordpress-nightly.zip + unzip -q $TMPDIR/wordpress-nightly/wordpress-nightly.zip -d $TMPDIR/wordpress-nightly/ + mv $TMPDIR/wordpress-nightly/wordpress/* $WP_CORE_DIR + else + if [ $WP_VERSION == 'latest' ]; then + local ARCHIVE_NAME='latest' + elif [[ $WP_VERSION =~ [0-9]+\.[0-9]+ ]]; then + # https serves multiple offers, whereas http serves single. + download https://api.wordpress.org/core/version-check/1.7/ $TMPDIR/wp-latest.json + if [[ $WP_VERSION =~ [0-9]+\.[0-9]+\.[0] ]]; then + # version x.x.0 means the first release of the major version, so strip off the .0 and download version x.x + LATEST_VERSION=${WP_VERSION%??} + else + # otherwise, use the exact version + LATEST_VERSION=$WP_VERSION + fi + local ARCHIVE_NAME="wordpress-$LATEST_VERSION" + else + local ARCHIVE_NAME="wordpress-$WP_VERSION" + fi + download https://wordpress.org/${ARCHIVE_NAME}.tar.gz $TMPDIR/wordpress.tar.gz + tar --strip-components=1 -zxmf $TMPDIR/wordpress.tar.gz -C $WP_CORE_DIR + fi + + download https://raw.github.com/markoheijnen/wp-mysqli/master/db.php $WP_CORE_DIR/wp-content/db.php +} + +install_test_suite() { + # portable in-place argument for both GNU sed and Mac OSX sed + if [[ $(uname -s) == 'Darwin' ]]; then + local ioption='-i .bak' + else + local ioption='-i' + fi + + # set up testing suite if it doesn't yet exist + if [ ! -d $WP_TESTS_DIR ]; then + # set up testing suite + mkdir -p $WP_TESTS_DIR + svn co --quiet https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/includes/ $WP_TESTS_DIR/includes + svn co --quiet https://develop.svn.wordpress.org/${WP_TESTS_TAG}/tests/phpunit/data/ $WP_TESTS_DIR/data + fi + + if [ ! -f wp-tests-config.php ]; then + download https://develop.svn.wordpress.org/${WP_TESTS_TAG}/wp-tests-config-sample.php "$WP_TESTS_DIR"/wp-tests-config.php + # remove all forward slashes in the end + WP_CORE_DIR=$(echo $WP_CORE_DIR | sed "s:/\+$::") + sed $ioption "s:dirname( __FILE__ ) . '/src/':'$WP_CORE_DIR/':" "$WP_TESTS_DIR"/wp-tests-config.php + sed $ioption "s/youremptytestdbnamehere/$DB_NAME/" "$WP_TESTS_DIR"/wp-tests-config.php + sed $ioption "s/yourusernamehere/$DB_USER/" "$WP_TESTS_DIR"/wp-tests-config.php + sed $ioption "s/yourpasswordhere/$DB_PASS/" "$WP_TESTS_DIR"/wp-tests-config.php + sed $ioption "s|localhost|${DB_HOST}|" "$WP_TESTS_DIR"/wp-tests-config.php + fi + +} + +install_db() { + + if [ ${SKIP_DB_CREATE} = "true" ]; then + return 0 + fi + + # parse DB_HOST for port or socket references + local PARTS=(${DB_HOST//\:/ }) + local DB_HOSTNAME=${PARTS[0]}; + local DB_SOCK_OR_PORT=${PARTS[1]}; + local EXTRA="" + + if ! [ -z $DB_HOSTNAME ] ; then + if [ $(echo $DB_SOCK_OR_PORT | grep -e '^[0-9]\{1,\}$') ]; then + EXTRA=" --host=$DB_HOSTNAME --port=$DB_SOCK_OR_PORT --protocol=tcp" + elif ! [ -z $DB_SOCK_OR_PORT ] ; then + EXTRA=" --socket=$DB_SOCK_OR_PORT" + elif ! [ -z $DB_HOSTNAME ] ; then + EXTRA=" --host=$DB_HOSTNAME --protocol=tcp" + fi + fi + + # create database + mysqladmin create $DB_NAME --user="$DB_USER" --password="$DB_PASS"$EXTRA +} + +install_wp +install_test_suite +install_db \ No newline at end of file diff --git a/phpunit.xml b/phpunit.xml new file mode 100644 index 0000000..45084e7 --- /dev/null +++ b/phpunit.xml @@ -0,0 +1,18 @@ + + + + + ./tests/ + + + + + + \ No newline at end of file diff --git a/tests/bootstrap.php b/tests/bootstrap.php new file mode 100644 index 0000000..20536c7 --- /dev/null +++ b/tests/bootstrap.php @@ -0,0 +1,30 @@ +settings_instance = new Wp_Scss_Settings(); + } + + public function tearDown(): void { + parent::tearDown(); + + // Clean up options + delete_option( 'wpscss_options' ); + } + + /** + * Test that the sanitize method preserves all form fields + * This tests the bug fix for settings not being saved + */ + public function test_sanitize_preserves_all_fields() { + $input = array( + 'base_compiling_folder' => 'Current Theme', + 'scss_dir' => '/scss/', + 'css_dir' => '/css/', + 'cache_dir' => '/cache/', + 'compiling_options' => 'compressed', + 'sourcemap_options' => 'SOURCE_MAP_NONE', + 'errors' => 'show', + 'enqueue' => '1', + 'always_recompile' => '1' + ); + + $result = $this->settings_instance->sanitize( $input ); + + // Test that all fields are preserved + $this->assertEquals( 'Current Theme', $result['base_compiling_folder'] ); + $this->assertEquals( '/scss/', $result['scss_dir'] ); + $this->assertEquals( '/css/', $result['css_dir'] ); + $this->assertEquals( '/cache/', $result['cache_dir'] ); + $this->assertEquals( 'compressed', $result['compiling_options'] ); + $this->assertEquals( 'SOURCE_MAP_NONE', $result['sourcemap_options'] ); + $this->assertEquals( 'show', $result['errors'] ); + $this->assertEquals( '1', $result['enqueue'] ); + $this->assertEquals( '1', $result['always_recompile'] ); + } + + /** + * Test directory path sanitization with trailing slash addition + */ + public function test_sanitize_adds_trailing_slashes() { + $input = array( + 'scss_dir' => '/scss', + 'css_dir' => '/css', + 'cache_dir' => '/cache' + ); + + $result = $this->settings_instance->sanitize( $input ); + + $this->assertEquals( '/scss/', $result['scss_dir'] ); + $this->assertEquals( '/css/', $result['css_dir'] ); + $this->assertEquals( '/cache/', $result['cache_dir'] ); + } + + /** + * Test that directory paths already with trailing slashes are preserved + */ + public function test_sanitize_preserves_existing_trailing_slashes() { + $input = array( + 'scss_dir' => '/scss/', + 'css_dir' => '/css/', + 'cache_dir' => '/cache/' + ); + + $result = $this->settings_instance->sanitize( $input ); + + $this->assertEquals( '/scss/', $result['scss_dir'] ); + $this->assertEquals( '/css/', $result['css_dir'] ); + $this->assertEquals( '/cache/', $result['cache_dir'] ); + } + + /** + * Test checkbox field handling + */ + public function test_sanitize_checkbox_fields() { + // Test checkbox checked + $input_checked = array( + 'enqueue' => '1', + 'always_recompile' => '1' + ); + + $result = $this->settings_instance->sanitize( $input_checked ); + $this->assertEquals( '1', $result['enqueue'] ); + $this->assertEquals( '1', $result['always_recompile'] ); + + // Test checkbox unchecked (empty) + $input_unchecked = array(); + + $result = $this->settings_instance->sanitize( $input_unchecked ); + $this->assertEquals( '0', $result['enqueue'] ); + $this->assertEquals( '0', $result['always_recompile'] ); + } + + /** + * Test handling of empty/missing fields + */ + public function test_sanitize_handles_empty_fields() { + $input = array( + 'base_compiling_folder' => '', + 'scss_dir' => '', + 'css_dir' => '/css/', + 'compiling_options' => '', + ); + + $result = $this->settings_instance->sanitize( $input ); + + // Empty fields should not be set in result + $this->assertArrayNotHasKey( 'base_compiling_folder', $result ); + $this->assertArrayNotHasKey( 'scss_dir', $result ); + $this->assertArrayNotHasKey( 'compiling_options', $result ); + + // Non-empty fields should be preserved + $this->assertEquals( '/css/', $result['css_dir'] ); + + // Checkboxes should default to '0' + $this->assertEquals( '0', $result['enqueue'] ); + $this->assertEquals( '0', $result['always_recompile'] ); + } + + /** + * Test text field sanitization + */ + public function test_sanitize_text_fields() { + $input = array( + 'base_compiling_folder' => 'Current Theme', + 'compiling_options' => 'compressed