Makefile

include makeutil/baseConfig.mk

SHELL=bash

git:
	type $@ > /dev/null 2>&1 || ( echo $@ is not installed; exit 10 )

#
makeutil/baseConfig.mk: git
	test -f $@																					||	\
		git clone "https://phabricator.nichework.com/source/makefile-skeleton" makeutil

# Name of the extension under test
mwExtensionUnderTest ?= Set-mwExtensionUnderTest
# Name of the branch under test
mwExtGitBranchUnderTest ?= $(shell git branch --show-current)
# Any dependent extensions (space separated)
mwDepExtensions ?=
# PHPUnit will look for this string and filter by it
mwTestFilter ?=
# PHPUnit will run tests in this group
mwTestGroup ?=
# PHPUnit will run tests in this path (relative to MW_INSTALL_PATH)
mwTestPath ?=

#
extensionDirs = echo $(1) | sed 's,^,extensions/,; s, , extensions/,g;'
commafyExtList = echo $(1) | sed 's/ /,/g;'
getPackagistUnderTest=test ! -f ${MW_INSTALL_PATH}/extensions/${mwExtensionUnderTest}/composer.json || ( cd ${MW_INSTALL_PATH}/extensions/${mwExtensionUnderTest} && ${compPath} config name )
packagistVersion ?= dev-${mwExtGitBranchUnderTest}

# Image name
mwImage ?= mediawiki
# Version to test
mwVer ?= 1.35

# Image based on image name + version
#
containerID ?= ${mwImage}:${mwVer}

# These are based on the image
#
MW_INSTALL_PATH ?= /var/www/html
WEB_GROUP ?= www-data
WEB_USER ?= www-data
WEB_ROOT ?= /var/www

# Setting up the wiki
#
MW_DB_TYPE ?= sqlite
MW_DB_NAME ?= my_wiki
MW_DB_SERVER ?= localhost
MW_DB_PATH ?= ${mwCiPath}/data
MW_DB_USER ?= wikiuser
MW_DB_PASS ?= wikipass
MW_PASSWORD ?= ugly123456
MW_WIKI_USER ?= WikiSysop
MW_SCRIPTPATH ?= ""
DB_ROOT_USER ?= root
DB_ROOT_PASS ?=


# Name of the wiki
MW_SITE_NAME ?= ${mwExtensionUnderTest}

#
binDir ?= /usr/local/bin
actUrl ?= https://github.com/nektos/act
mwCiPath ?= ${PWD}/conf
phpIni ?= ${mwCiPath}/php-settings.ini
mwBranch ?= $(shell echo ${mwVer} | (echo -n REL; tr . _))
dockerCli ?= podman
miniSudo ?= podman unshare
mwImgVersion ?= mediawiki:${mwVer}
memcImgVersion ?= docker.io/library/memcached:latest
mwDomain ?= localhost
logDir ?= ${PWD}/logs
mwWebPort ?= 8000
mwContainer ?= mediawiki-${mwExtensionUnderTest}
mwWebUser ?= www-data:www-data
mwDbPath ?= ${mwCiPath}/sqlite-data
mwVendor ?= ${mwCiPath}/vendor
mwAptPath ?= ${mwCiPath}/apt
mwDotComposer ?= ${mwCiPath}/dot-composer
mwSkins ?= ${mwCiPath}/skins
contPath ?= /var/www/html
mwContPath ?= ${contPath}
compPath ?= ${binDir}/composer
extensionsPath ?= ${mwContPath}/extensions
mwCiExtensions ?= ${mwCiPath}/extensions
importData ?= test-data/import.xml
phpunitOptions ?= --testdox
autoloadClassmap ?= ${mwVendor}/composer/autoload_classmap.php

lsPath=${mwCiPath}/LocalSettings.php
mwCompLocal=${mwCiPath}/composer.local.json

# Run phpunit tests for this extension
test: build.tar.gz pullContainer
	${make} inContainer target=testInContainer

# Build test environment for this extension
build: pullContainer
	test -f ${mwCiPath}/build.tar.gz															&&	\
		echo "build.tar.gz already exists, not re-creating."									||	\
		${make} inContainer target=buildInContainer

#
${phpIni}: MW_CI_PATH
	test -z "$@" -o -f "$@"																	||	(	\
		echo '[PHP]'																			&&	\
		echo 'error_reporting = E_ALL & ~E_DEPRECATED & ~E_STRICT & ~E_NOTICE'						\
	) > $@

.PHONY: pullContainer
pullContainer:
	export hasIt=`${dockerCli} images -q ${containerID}`										&&	\
	test -n "$$hasIt"																			&&	\
		echo "The container (${containerID}) does not need to be pulled again."					||	\
		${dockerCli} pull ${containerID}

build.tar.gz: build

verifyInContainerEnvVar:
	test -n "${mwExtensionUnderTest}" 														||	(	\
		echo "You must set the mwExtensionUnderTest variable."									&&	\
		echo "See <http://hexm.de/glcivar>"; exit 10												\
	)

inContainer:
	test -n "${target}" 																	||	(	\
		echo "You must specify a target for the container to execute"							&&	\
		echo "See <http://hexm.de/glcivar>"; exit 10												\
	)
	mkdir -p ${mwVendor}
	${dockerCli} run --rm -w /target -v "${PWD}:/target" ${containerID}								\
		make ${target} VERBOSE=${VERBOSE} phpunitOptions="${phpunitOptions}" 						\
			mwExtensionUnderTest="${mwExtensionUnderTest}" mwTestGroup="${mwTestGroup}"				\
			mwTestFilter="${mwTestFilter}" mwTestPath="${mwTestPath}" WEB_GROUP="${WEB_GROUP}"		\
			MW_INSTALL_PATH="${MW_INSTALL_PATH}" WEB_ROOT="${WEB_ROOT}" WEB_USER="${WEB_USER}"		\
			mwDepExtensions="${mwDepExtensions}" MW_DB_PATH="${MW_DB_PATH}"							\
			MW_DB_TYPE="${MW_DB_TYPE}" MW_DB_SERVER="${MW_DB_SERVER}"  MW_DB_PASS="${MW_DB_PASS}"	\
			MW_DB_NAME="${MW_DB_NAME}" DB_ROOT_PASS="${DB_ROOT_PASS}" DB_ROOT_USER="${DB_ROOT_USER}"

linkInContainer:
	test -e ${target}																		||	(	\
		echo ${indent}"Target does not exist, setting up (possibly empty) symlink..."				\
	)
	test -L ${target}																		||	(	\
		echo ${indent}"Linking target (${target}) to source (${src}) in container..."	&&			\
		test ! -e ${src}																||	(		\
			echo ${indent}"Source exists, not copying"										&&		\
			rm -rf ${target}																		\
		)																				&&			\
		test ! -e ${target}																||	(		\
			echo ${indent}"Copying source initially."										&&		\
			cp -pr ${target} ${src}															&&		\
			rm -rf ${target}																		\
		)																						&&	\
		ln -s ${src} ${target}																		\
	)

linksInContainer:
	echo ${indent}"Setting up symlinks for container"
	for extension in ${mwDepExtensions} ${mwExtensionUnderTest}; do									\
		${make} linkInContainer target=${MW_INSTALL_PATH}/extensions/$$extension					\
							src=${mwCiExtensions}/$$extension									;	\
	done
	${make} linkInContainer target=${MW_INSTALL_PATH}/LocalSettings.php								\
							src=${mwCiPath}/LocalSettings.php
	${make} linkInContainer target=${MW_INSTALL_PATH}/vendor              src=${mwVendor}
	${make} linkInContainer target=${MW_INSTALL_PATH}/composer.local.json src=${mwCompLocal}
	${make} linkInContainer target=${MW_INSTALL_PATH}/composer.lock									\
							src=${mwCiPath}/composer.lock
	${make} linkInContainer target=${MW_INSTALL_PATH}/composer.json									\
							src=${mwCiPath}/composer.json

composerBinaryInContainer:
	test -x ${mwCiPath}/composer.phar														||	(	\
		${make} pkgInContainer bin=unzip														&&	\
		echo ${indent}"Getting composer..."														&&	\
		cd ${mwCiPath}																			&&	\
		curl -o installer "https://getcomposer.org/installer"									&&	\
		curl -o expected "https://composer.github.io/installer.sig"								&&	\
		echo `cat expected` " installer" | sha384sum -c -										&&	\
		php installer																				\
	)
	test -x ${compPath}																			||	\
		cp -p ${mwCiPath}/composer.phar ${compPath}

${mwCompLocal}:
	export packagistUnderTest=`$(call getPackagistUnderTest)`									&&	\
	test -z "$$packagistUnderTest"															&&	(	\
		echo {} > $@																				\
	)																						||	(	\
		COMPOSER=${mwCiPath}/composer.local.json ${compPath} require --no-update					\
			 --working-dir=${MW_INSTALL_PATH} $$packagistUnderTest @dev							&&	\
		COMPOSER=${mwCiPath}/composer.local.json ${compPath} config									\
			repositories.$$packagistUnderTest --working-dir=${MW_INSTALL_PATH}						\
			'{"type": "path", "url": "extensions/${mwExtensionUnderTest}"}'						&&	\
		COMPOSER=${mwCiPath}/composer.local.json ${compPath} require --no-update					\
			 --working-dir=${MW_INSTALL_PATH} mediawiki/semantic-media-wiki @dev				&&	\
		COMPOSER=${mwCiPath}/composer.local.json ${compPath} config									\
			repositories.semantic-media-wiki --working-dir=${MW_INSTALL_PATH}						\
			'{"type": "path", "url": "extensions/SemanticMediaWiki"}'							&&	\
		${compPath} update --working-dir=${MW_INSTALL_PATH}											\
	)

pkgInContainer: verifyInContainerEnvVar
	type ${bin} > /dev/null 2>&1 															||	(	\
		echo ${indent}"Installing $(if ${pkg},${pkg},${bin})..."								&&	\
		apt update																				&&	\
		apt install -y $(if ${pkg},${pkg},${bin})													\
	)

SemanticMediaWiki:
	${make} smwVCS target=$@

SemanticInterlanguageLinks:
	${make} smwVCS target=$@

.PHONY: smwVCS
smwVCS:
	test "${mwExtensionUnderTest}" = "${target}"											||	(	\
		test ! -d ${mwCiExtensions}/${target}											||	(		\
			cd ${mwCiExtensions}/${target}													&&		\
			test -z "`git branch --show-current`"											||		\
				git pull																			\
		)																					&&		\
		test -d ${mwCiExtensions}/${target}												||	(		\
			git clone "https://github.com/SemanticMediaWiki/${target}.git"							\
				${mwCiExtensions}/${target}															\
		)																							\
	)																							&&	\
	mkdir -p ${mwCiExtensions}																	&&	\
	test -e ${mwCiExtensions}/${target}															||	\
			ln -s ${PWD} ${mwCiExtensions}/${target}

runComposerInContainer: linksInContainer ${mwExtensionUnderTest} ${mwDepExtensions} ${mwCompLocal}
	${make} pkgInContainer bin=unzip
	echo ${indent}"Running composer..."
	php ${compPath} update --working-dir ${MW_INSTALL_PATH}

installExtensionInContainer: verifyInContainerEnvVar
	echo ${indent}"Installing MediaWiki to test ${mwExtensionUnderTest}..."
	mkdir -p ${MW_DB_PATH}
	php ${MW_INSTALL_PATH}/maintenance/install.php --dbtype=${MW_DB_TYPE} --dbname=${MW_DB_NAME}	\
			--dbserver=${MW_DB_SERVER} --dbuser=${MW_DB_USER} --dbpass=${MW_DB_PASS}				\
			--installdbuser=${DB_ROOT_USER} --installdbpass=${DB_ROOT_PWD} --pass=${MW_PASSWORD}	\
			--scriptpath=${MW_SCRIPTPATH} --dbpath=${MW_DB_PATH} --server="http://localhost:8000"	\
			--extensions=`$(call commafyExtList,${mwDepExtensions})`,${mwExtensionUnderTest}		\
			${mwExtensionUnderTest}-test ${MW_WIKI_USER}
	${make} linkInContainer target=${MW_INSTALL_PATH}/LocalSettings.php								\
							src=${mwCiPath}/LocalSettings.php

enableDebugOutput:
	echo 'error_reporting(E_ALL| E_STRICT);' >> ${mwCiPath}/LocalSettings.php
	echo 'ini_set("display_errors", 1);' >> ${mwCiPath}/LocalSettings.php
	echo '$$wgShowExceptionDetails = true;' >> ${mwCiPath}/LocalSettings.php
	echo '$$wgDevelopmentWarnings = true;' >> ${mwCiPath}/LocalSettings.php
	cat ${mwCiPath}/LocalSettings.php

enableSemanticsAndUpdate:
	echo "enableSemantics( 'localhost' );" >> ${mwCiPath}/LocalSettings.php
	php ${MW_INSTALL_PATH}/maintenance/update.php --quick
	chown -R "${WEB_USER}:${WEB_GROUP}" ${MW_DB_PATH}

actInstall:
	test -x ${binDir}/act																	||	(	\
		export version=`curl -s -I ${actUrl}/releases/latest								2>&1|	\
			awk '/^location:/ {print $$2}'														|	\
			sed 's,.*/\([^/]*\)$$,\1,; s,\\r,,'`												&&	\
		export kernel=`uname -s`																&&	\
		export machine=`uname -m`																&&	\
		curl -s -L ${actUrl}/releases/download/$$version/act_"$$kernel"_$$machine.tar.gz		|	\
			tar -C ${binDir} -xz act															&&	\
		chmod +x ${binDir}/act																		\
	)

localTestGithub: actInstall
	act $(if ${VERBOSE},--verbose)

# From https://www.wezm.net/technical/2008/03/create-empty-tar-file/
buildOnGithub:
	tar czf ${mwCiPath}/build.tar.gz --files-from /dev/null

buildInContainer:
	test -f ${mwCiPath}/build.tar.gz 														||	(	\
		${make} composerBinaryInContainer														&&	\
		${make} linksInContainer																&&	\
		${make} runComposerInContainer															&&	\
		${make} installExtensionInContainer														&&	\
		echo ${indent}"Creating build.tar.gz"													&&	\
		tar -C ${mwCiPath} -czf ${mwCiPath}/build.tar.gz 											\
			LocalSettings.php composer composer.local.json composer.{json,lock} vendor data 		\
			$(call extensionDirs,${mwDepExtensions} ${mwExtensionUnderTest})						\
	)

testInContainer: buildInContainer
	tar -C ${mwCiPath} -xzf ${mwCiPath}/build.tar.gz
	${make} linksInContainer
	${make} composerBinaryInContainer
	cd ${MW_INSTALL_PATH}/extensions/${mwExtensionUnderTest}									&&	\
		php ${compPath} test --working-dir=${MW_INSTALL_PATH}/extensions/${mwExtensionUnderTest}