senaduka/old-uokvirime-plugin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Plugin stub

Browse Source
This commit is contained in:
Senad Uka
2020-07-07 05:58:56 +02:00
parent a9222a93fc
commit abc8c58db5
12 changed files with 76 additions and 469 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
.travis.yml
View File

@@ -1,29 +0,0 @@
sudo: false
language: php
notifications:
email:
on_success: never
on_failure: change
branches:
only:
- master
php:
- 5.6
matrix:
include:
- php: 5.6
env: WP_VERSION=latest
before_script:
- export PATH="$HOME/.composer/vendor/bin:$PATH"
- bash bin/install-wp-tests.sh wordpress_test root '' localhost $WP_VERSION
- composer global require "phpunit/phpunit=4.8.*|5.7.*"
script:
- phpunit
- WP_MULTISITE=1 phpunit

136
README.md Normal file → Executable file
View File

@@ -1,137 +1 @@
# WordPress plugin or theme development with Docker Compose
[![Build status][build-status]][travis-ci]
This is an example repo for how one might wire up Docker Compose for local
plugin or theme development. It provides WordPress, MariaDB, WP-CLI, PHPUnit,
and the WordPress unit testing suite.
## Set up
1. Clone or fork this repo.
2. Put your plugin or theme code in the root of this folder and adjust the
`services/wordpress/volumes` section of `docker-compose.yml` so that it
syncs to the appropriate directory.
3. Add `project.test` to `/etc/hosts`, e.g.:
```
127.0.0.1 localhost project.test
```
## Start environment
```sh
docker-compose up -d
```
The first time you run this, it will take a few minutes to pull in the required
images. On subsequent runs, it should take less than 30 seconds before you can
connect to WordPress in your browser. (Most of this time is waiting for MariaDB
to be ready to accept connections.)
The `-d` flag backgrounds the process and log output. To view logs for a
specific container, use `docker-compose logs [container]`, e.g.:
```sh
docker-compose logs wordpress
```
Please refer to the [Docker Compose documentation][docker-compose] for more
information about starting, stopping, and interacting with your environment.
## Install WordPress
```sh
docker-compose run --rm wp-cli install-wp
```
Log in to `http://project.test/wp-admin/` with `wordpress` / `wordpress`.
Alternatively, you can navigate to `http://project.test/` and manually perform
the famous five-second install.
## WP-CLI
You will probably want to [create a shell alias][3] for this:
```sh
docker-compose run --rm wp-cli wp [command]
```
## Running tests (PHPUnit)
The tests in this example repo were generated with WP-CLI, e.g.:
```sh
docker-compose run --rm wp-cli wp scaffold plugin-tests my-plugin
```
This is not required, however, and you can bring your own test scaffold. The
important thing is that you provide a script to install your test dependencies,
and that these dependencies are staged in `/tmp`.
The testing environment is provided by a separate Docker Compose file
(`docker-compose.phpunit.yml`) to ensure isolation. To use it, you must first
start it, then manually run your test installation script. These commands work
for this example repo, but may not work for you if you use a different test
scaffold.
Note that, in the PHPUnit container, your code is mapped to `/app`.
```sh
docker-compose -f docker-compose.yml -f docker-compose.phpunit.yml up -d
docker-compose -f docker-compose.phpunit.yml run --rm wordpress_phpunit /app/bin/install-wp-tests.sh wordpress_test root '' mysql_phpunit latest true
```
Now you are ready to run PHPUnit. Repeat this command as necessary:
```sh
docker-compose -f docker-compose.phpunit.yml run --rm wordpress_phpunit phpunit
```
## Changing the hostname
You can change the hostname from the default `project.test` by adding a `.env`
file at the project root and defining the `DOCKER_DEV_DOMAIN` environment
variable:
```
DOCKER_DEV_DOMAIN=myproject.test
```
## Seed MariaDB database
The `mariadb` image supports initializing the database with content by mounting
a volume to the database container at `/docker-entrypoint-initdb.d`. See the
[MariaDB Docker docs][mariadb-docs] for more information.
## Troubleshooting
If your stack is not responding, the most likely cause is that a container has
stopped or failed to start. Check to see if all of the containers are "Up":
```
docker-compose ps
```
If not, inspect the logs for that container, e.g.:
```
docker-compose logs wordpress
```
[build-status]: https://travis-ci.org/chriszarate/docker-compose-wordpress.svg?branch=master
[travis-ci]: https://travis-ci.org/chriszarate/docker-compose-wordpress
[docker-compose]: https://docs.docker.com/compose/
[mariadb-docs]: https://github.com/docker-library/docs/tree/master/mariadb#initializing-a-fresh-instance

127
bin/install-wp-tests.sh
View File

@@ -1,127 +0,0 @@
#!/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}
WP_TESTS_DIR=${WP_TESTS_DIR-/tmp/wordpress-tests-lib}
WP_CORE_DIR=${WP_CORE_DIR-/tmp/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]+(\.[0-9]+)? ]]; then
WP_TESTS_TAG="tags/$WP_VERSION"
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 /tmp/wordpress-nightly
download https://wordpress.org/nightly-builds/wordpress-latest.zip /tmp/wordpress-nightly/wordpress-nightly.zip
unzip -q /tmp/wordpress-nightly/wordpress-nightly.zip -d /tmp/wordpress-nightly/
mv /tmp/wordpress-nightly/wordpress/* $WP_CORE_DIR
else
if [ $WP_VERSION == 'latest' ]; then
local ARCHIVE_NAME='latest'
else
local ARCHIVE_NAME="wordpress-$WP_VERSION"
fi
download https://wordpress.org/${ARCHIVE_NAME}.tar.gz /tmp/wordpress.tar.gz
tar --strip-components=1 -zxmf /tmp/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

16
bin/install-wp.sh
View File

@@ -1,16 +0,0 @@
#!/usr/bin/env sh
# Install WordPress.
wp core install \
--title="Project" \
--admin_user="wordpress" \
--admin_password="wordpress" \
--admin_email="admin@example.com" \
--url="http://project.test" \
--skip-email
# Update permalink structure.
wp option update permalink_structure "/%year%/%monthnum%/%postname%/" --skip-themes --skip-plugins
# Activate plugin.
wp plugin activate my-plugin

18
class-my-plugin.php
View File

@@ -1,18 +0,0 @@
<?php
/**
* Plugin Name: My Plugin
* Plugin URI: PLUGIN SITE HERE
* Description: PLUGIN DESCRIPTION HERE
* Author: YOUR NAME HERE
* Author URI: YOUR SITE HERE
* Text Domain: my-plugin
* Domain Path: /languages
* Version: 0.1.0
*
* @package My_Plugin
*/
/**
* My Plugin class
*/
class My_Plugin {}

17
docker-compose.phpunit.yml
View File

@@ -1,17 +0,0 @@
version: "3"
services:
wordpress_phpunit:
image: "chriszarate/wordpress-phpunit:6.0.6"
volumes:
- ".:/app"
- "testsuite:/tmp"
mysql_phpunit:
image: "mariadb:10.2"
environment:
MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
MYSQL_DATABASE: "wordpress_test"
MYSQL_ROOT_PASSWORD: ""
volumes:
testsuite: {}

57
docker-compose.yml
View File

@@ -1,57 +0,0 @@
version: "3"
services:
wordpress:
image: "wordpress:${WP_VERSION:-5.2.1}-php${PHP_VERSION:-7.3}-apache"
environment:
VIRTUAL_HOST: "${DOCKER_DEV_DOMAIN:-project.test}"
WORDPRESS_DB_HOST: "mysql"
WORDPRESS_DB_NAME: "wordpress"
WORDPRESS_DB_PASSWORD: ""
WORDPRESS_DB_USER: "root"
depends_on:
- "mysql"
networks:
- "front"
- "back"
volumes:
- "wp:/var/www/html:rw"
- ".:/var/www/html/wp-content/plugins/my-plugin:ro"
wp-cli:
image: "wordpress:cli-${WP_CLI_VERSION:-2.2.0}-php${PHP_VERSION:-7.3}"
environment:
- APACHE_RUN_USER="www-data"
- APACHE_RUN_GROUP="www-data"
depends_on:
- "mysql"
networks:
- "back"
volumes:
- "wp:/var/www/html:rw"
- "./bin/install-wp.sh:/usr/local/bin/install-wp:ro"
- ".:/var/www/html/wp-content/plugins/my-plugin:ro"
mysql:
image: "mariadb:10.2"
environment:
MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
MYSQL_DATABASE: "wordpress"
MYSQL_ROOT_PASSWORD: ""
networks:
- "back"
proxy:
image: "jwilder/nginx-proxy:alpine"
ports:
- "80:80"
networks:
front:
aliases:
- "${DOCKER_DEV_DOMAIN:-project.test}"
volumes:
- "/var/run/docker.sock:/tmp/docker.sock:ro"
networks:
front: {}
back: {}
volumes:
wp: {}

10
phpcs.ruleset.xml
View File

@@ -1,10 +0,0 @@
<?xml version="1.0"?>
<ruleset name="WordPress Coding Standards for Plugins">
<description>Generally-applicable sniffs for WordPress plugins</description>
<rule ref="WordPress-Core" />
<rule ref="WordPress-Docs" />
<exclude-pattern>*/node_modules/*</exclude-pattern>
<exclude-pattern>*/vendor/*</exclude-pattern>
</ruleset>

14
phpunit.xml.dist
View File

@@ -1,14 +0,0 @@
<phpunit
bootstrap="tests/bootstrap.php"
backupGlobals="false"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
>
<testsuites>
<testsuite>
<directory prefix="class-test-" suffix=".php">./tests/</directory>
</testsuite>
</testsuites>
</phpunit>

25
tests/bootstrap.php
View File

@@ -1,25 +0,0 @@
<?php
/**
* PHPUnit bootstrap file
*
* @package My_Plugin
*/
$_tests_dir = getenv( 'WP_TESTS_DIR' );
if ( ! $_tests_dir ) {
$_tests_dir = '/tmp/wordpress-tests-lib';
}
// Give access to tests_add_filter() function.
require_once $_tests_dir . '/includes/functions.php';
/**
* Manually load the plugin being tested.
*/
function _manually_load_plugin() {
require dirname( dirname( __FILE__ ) ) . '/class-my-plugin.php';
}
tests_add_filter( 'muplugins_loaded', '_manually_load_plugin' );
// Start up the WP testing environment.
require $_tests_dir . '/includes/bootstrap.php';

20
tests/class-test-sample.php
View File

@@ -1,20 +0,0 @@
<?php
/**
* Class Test_Sample
*
* @package My_Plugin
*/
/**
* Sample test case.
*/
class Test_Sample extends WP_UnitTestCase {
/**
* A single example test.
*/
function test_example() {
// Replace this with some actual testing code.
$this->assertTrue( class_exists( 'My_Plugin' ) );
}
}

76
uokvirime.php Executable file
View File

@@ -0,0 +1,76 @@
<?php
/**
* Plugin Name: Uokviri Me Plugin
* Plugin URI: https://www.uokviri.me
* Description: Uokviri me specific functionality
* Author: Saburly
* Author URI: www.saburly.com
* Version: 0.1.0
*
* @package Uokviri_Me
*/
function uokvirime_get_lyric() {
/** These are the lyrics to Hello Dolly */
$lyrics = "Oj djevojko anadolko
Budi moja ti
Oj djevojko anadolko
Budi moja ti
Ja cu tebi sevdalinke
Pjesme pjevati";
// Here we split it into lines.
$lyrics = explode( "\n", $lyrics );
// And then randomly choose a line.
return wptexturize( $lyrics[ mt_rand( 0, count( $lyrics ) - 1 ) ] );
}
// This just echoes the chosen line, we'll position it later.
function uokvirime() {
$chosen = uokvirime_get_lyric();
$lang = '';
if ( 'en_' !== substr( get_user_locale(), 0, 3 ) ) {
$lang = ' lang="en"';
}
printf(
'<p id="dolly"><span class="screen-reader-text">%s </span><span dir="ltr"%s>%s</span></p>',
__( 'Quote from Hello Dolly song, by Jerry Herman:' ),
$lang,
$chosen
);
}
// Now we set that function up to execute when the admin_notices action is called.
add_action( 'admin_notices', 'uokvirime' );
// We need some CSS to position the paragraph.
function uokvirime_css() {
echo "
<style type='text/css'>
#dolly {
float: right;
padding: 5px 10px;
margin: 0;
font-size: 12px;
line-height: 1.6666;
}
.rtl #dolly {
float: left;
}
.block-editor-page #dolly {
display: none;
}
@media screen and (max-width: 782px) {
#dolly,
.rtl #dolly {
float: none;
padding-left: 0;
padding-right: 0;
}
}
</style>
";
}
add_action( 'admin_head', 'uokvirime_css' );