Fix typo and add tests (#8)

* Fix typo and add tests

* Fix comments

* Add install script

* Bump polyfill version

* one more

* Add 8.1 version

* Fixes

* Go back down to 8

* Let's just do one for now

* Let's give this another go

* Remove erroneous character

* .

* Work with exceptions

* Next iteration

* update

* final one?

* nonce

* Next try

* remove chars

* update

* .

.github/workflows/phpunit.yml

@@ -0,0 +1,41 @@
+name: PHPUnit
+
+on: [push]
+
+env:
+  WP_TESTS_DIR: /github/home/wp-tests/wordpress-tests-lib
+  WP_CORE_DIR: /github/home/wp-tests/wordpress
+
+jobs:
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-version: [ 7.4 ]
+        wordpress-version: [ latest ]
+    container:
+      image: junaidbhura/wp-tests:php-${{ matrix.php-version }}
+    services:
+      mysql:
+        image: mysql:5.7.27
+        env:
+          MYSQL_ROOT_PASSWORD: root
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v1
+
+      - name: Install Composer dependencies
+        run: |
+          composer install --no-dev
+          composer global require "phpunit/phpunit=5.7.27"
+          composer global require "yoast/phpunit-polyfills=1.1.0"
+
+      - name: Install WordPress test suite
+        run: bash bin/install-wp-tests.sh wordpress_test root root mysql ${{ matrix.wordpress-version }}
+
+      - name: Tests
+        run: | 
+          $HOME/.composer/vendor/bin/phpunit --config=phpunit.xml
+          WP_MULTISITE=1 $HOME/.composer/vendor/bin/phpunit --config=phpunit.xml

bin/install-wp-tests.sh

@@ -0,0 +1,149 @@
+#!/usr/bin/env bash
+
+if [ $# -lt 3 ]; then
+	echo "usage: $0 <db-name> <db-user> <db-pass> [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, scan the releases and get the most up to date minor version of the major release
+				local VERSION_ESCAPED=`echo $WP_VERSION | sed 's/\./\\\\./g'`
+				LATEST_VERSION=$(grep -o '"version":"'$VERSION_ESCAPED'[^"]*' $TMPDIR/wp-latest.json | sed 's/"version":"//' | head -1)
+			fi
+			if [[ -z "$LATEST_VERSION" ]]; then
+				local ARCHIVE_NAME="wordpress-$WP_VERSION"
+			else
+				local ARCHIVE_NAME="wordpress-$LATEST_VERSION"
+			fi
+		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

composer.json

@@ -3,12 +3,29 @@
     "php": "^7.2|^8.0"
   },
   "require-dev": {
+    "phpunit/phpunit": "^7.0",
+    "yoast/phpunit-polyfills": "^1.1.0",
+    "mockery/mockery": "1.2",
+    "brain/monkey": "2.*",
     "dealerdirect/phpcodesniffer-composer-installer": "^0.7.2",
     "wp-coding-standards/wpcs": "^2.3"
   },
   "config": {
     "allow-plugins": {
       "dealerdirect/phpcodesniffer-composer-installer": true
     }
+  },
+  "autoload": {
+    "psr-4": {
+      "WordPressPlugin\\": "./php"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "WordPressPlugin\\Tests\\": "./tests"
+    }
+  },
+  "scripts": {
+    "test": "phpunit --config=tests/phpunit.xml"
   }
 }

phpunit.xml

@@ -0,0 +1,13 @@
+<phpunit
+		bootstrap="tests/bootstrap.php"
+		backupGlobals="false"
+		colors="true"
+		convertErrorsToExceptions="true"
+		convertWarningsToExceptions="true"
+>
+	<testsuites>
+		<testsuite name="wp-search-suggest">
+			<directory prefix="test-" suffix=".php">.</directory>
+		</testsuite>
+	</testsuites>
+</phpunit>

readme.txt

@@ -4,9 +4,9 @@ Tags: search, AJAX, jQuery
 Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TLX9TH5XRURBA
 Requires at least: 3.3
 Tested up to: 6.4
-Stable tag: 7
+Stable tag: 8
 
-Provides title suggestions while typing a search query, using the built in jQuery suggest script.
+Provides title suggestions while typing a search query, using the built-in jQuery suggest script.
 
 == Description ==
 
@@ -54,6 +54,9 @@ Make sure your theme's search input field has an `id="s"` and/or `name="s"` as i
 
 == Changelog ==
 
+= 8 =
+* Fixed a bug where search requests from logged-out users would not return results. See https://wordpress.org/support/topic/only-works-when-logged-in-18/
+
 = 7 =
 * Fixed a bug where the plugin would not work with PHP 8.0 and above. See https://wordpress.org/support/topic/after-php-8-not-working-again/
 

tests/bootstrap.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * PHPUnit bootstrap file for setting up WordPress testing.
+ *
+ * @package wp-search-suggest
+ */
+
+$_tests_dir = getenv( 'WP_TESTS_DIR' );
+if ( ! $_tests_dir ) {
+	$_tests_dir = rtrim( sys_get_temp_dir(), '/\\' ) . '/wordpress-tests-lib';
+}
+
+if ( ! file_exists( $_tests_dir . '/includes/functions.php' ) ) {
+	echo "Could not find $_tests_dir/includes/functions.php, have you run bin/install-wp-tests.sh?"; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+	exit( 1 );
+}
+
+// Give access to tests_add_filter() function.
+require_once $_tests_dir . '/includes/functions.php';
+
+/**
+ * Manually load the plugin being tested.
+ */
+function _manually_load_plugin() {
+	$root = dirname( __DIR__ );
+
+	require_once $root . '/wp-search-suggest.php';
+}
+tests_add_filter( 'muplugins_loaded', '_manually_load_plugin' );
+
+// Start up the WP testing environment.
+require $_tests_dir . '/includes/bootstrap.php';

tests/test-ajax-requests.php

@@ -0,0 +1,106 @@
+<?php // phpcs:disable Generic.CodeAnalysis.EmptyStatement.DetectedCatch
+/**
+ * Ajax requests test file.
+ *
+ * @package wp-search-suggest
+ */
+
+/**
+ * User meta related tests.
+ */
+class Ajax_Requests extends WP_Ajax_UnitTestCase {
+
+	/**
+	 * Set up before class.
+	 */
+	public static function set_up_before_class() {
+		parent::set_up_before_class();
+
+		add_action( 'wp_ajax_wp-search-suggest', 'wpss_ajax_response' );
+		add_action( 'wp_ajax_nopriv_wp-search-suggest', 'wpss_ajax_response' );
+	}
+
+	/**
+	 * Tests whether a logged-in user can access the AJAX request.
+	 *
+	 * @covers ::wpss_ajax_response
+	 */
+	public function test_logged_in_user_can_access() {
+		// Simulate a logged-in user.
+		$this->_setRole( 'subscriber' );
+
+		// Create a test post with a specific title.
+		$post_id = $this->factory->post->create( array( 'post_title' => 'Sample Post Title' ) );
+
+		// Set up the request with the first word of the post title as the query.
+		$_GET['q']        = 'Sample';
+		$_GET['_wpnonce'] = wp_create_nonce( 'wp-search-suggest' );
+
+		// Make the request.
+		try {
+			$this->_handleAjax( 'wp-search-suggest' );
+		} catch ( WPAjaxDieContinueException $exception ) {
+			// We expect this exception to be thrown.
+		}
+
+		// Assert that the response contains the post title.
+		$this->assertSame( 'Sample Post Title', $this->_last_response );
+
+		// Clean up by deleting the test post.
+		wp_delete_post( $post_id, true );
+	}
+
+	/**
+	 * Tests whether a logged-out user can access the AJAX request.
+	 *
+	 * @covers ::wpss_ajax_response
+	 */
+	public function test_logged_out_user_can_access() {
+		// Simulate a logged-out user.
+		$this->logout();
+
+		// Create a test post with a specific title.
+		$post_id = $this->factory->post->create( array( 'post_title' => 'Sample Post Title' ) );
+
+		// Set up the request with the first word of the post title as the query.
+		$_GET['q']        = 'Sample';
+		$_GET['_wpnonce'] = wp_create_nonce( 'wp-search-suggest' );
+
+		// Make the request.
+		try {
+			$this->_handleAjax( 'wp-search-suggest' );
+		} catch ( WPAjaxDieContinueException $exception ) {
+			// We expect this exception to be thrown.
+		}
+
+		// Assert that the response contains the post title.
+		$this->assertSame( 'Sample Post Title', $this->_last_response );
+
+		// Clean up by deleting the test post.
+		wp_delete_post( $post_id, true );
+	}
+
+	/**
+	 * Tests whether an invalid nonce is rejected.
+	 *
+	 * @covers ::wpss_ajax_response
+	 */
+	public function test_invalid_nonce_for_logged_in_user() {
+		// Simulate a logged-in user.
+		$this->_setRole( 'subscriber' );
+
+		// Set up the request with the invalid nonce.
+		$_GET['q']        = 'Title';
+		$_GET['_wpnonce'] = 'invalid_nonce';
+
+		// Make the request.
+		try {
+			$this->_handleAjax( 'wp-search-suggest' );
+		} catch ( WPAjaxDieStopException $exception ) {
+			// We expect this exception to be thrown.
+		}
+
+		// Assert that the response contains an error message.
+		$this->assertEmpty( $this->_last_response );
+	}
+}