Add deployer phpcs inspections action

mrrobot47 · mrrobot47 · commit 22db6a060f87 · 2019-03-06T17:34:12.000+05:30
Signed-off-by: Riddhesh Sanghvi &lt;riddheshsanghvi96@gmail.com&gt;
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,116 @@
+# alpine:latest at 2019-01-04T21:27:39IST
+FROM alpine@sha256:46e71df1e5191ab8b8034c5189e325258ec44ea739bba1e5645cff83c9048ff1
+
+LABEL "com.github.actions.icon"="search"
+LABEL "com.github.actions.name"="PHPCodeSniffer"
+LABEL "com.github.actions.description"="Check phpcs rules in the diff getting deployed"
+
+# Environments
+ENV TIMEZONE                 Asia/Kolkata
+ENV PHP_MEMORY_LIMIT         512M
+ENV MAX_UPLOAD               50M
+ENV PHP_MAX_FILE_UPLOAD      200
+ENV PHP_MAX_POST             100M
+ENV PHP_INI_DIR              /etc/php7/php.ini
+ENV HOME                     /root
+ENV PATH                     "/composer/vendor/bin:~/.local/bin:$PATH"
+ENV COMPOSER_ALLOW_SUPERUSER 1
+ENV COMPOSER_HOME            /composer
+
+# PHP-CLI installation inspired from https://github.com/bravist/php-cli-alpine-aliyun-app/blob/master/Dockerfile
+# https://github.com/matriphe/docker-alpine-php/blob/master/7.0/FPM/Dockerfile
+
+RUN apk update && \
+	apk upgrade && \
+	apk add \
+		bash \
+		jq \
+		curl \
+		git \
+		tzdata \
+		rsync \
+		mysql-client \
+		subversion \
+		unzip \
+		wget \
+		zip \
+		openssh-client \
+		php7 \
+		php7-dev \
+		php7-apcu \
+		php7-bcmath \
+		php7-bz2 \
+		php7-xmlwriter \
+		php7-ctype \
+		php7-curl \
+		php7-exif \
+		php7-iconv \
+		php7-intl \
+		php7-json \
+		php7-mbstring\
+		php7-opcache \
+		php7-openssl \
+		php7-pcntl \
+		php7-pdo \
+		php7-mysqlnd \
+		php7-mysqli \
+		php7-pdo_mysql \
+		php7-pdo_pgsql \
+		php7-phar \
+		php7-posix \
+		php7-session \
+		php7-xml \
+		php7-simplexml \
+		php7-mcrypt \
+		php7-xsl \
+		php7-zip \
+		php7-zlib \
+		php7-dom \
+		php7-redis\
+		php7-tokenizer \
+		php7-gd \
+		php7-fileinfo \
+		php7-zmq \
+		php7-memcached \
+		php7-xmlreader \
+		python \
+		py2-pip && \
+	cp /usr/share/zoneinfo/${TIMEZONE} /etc/localtime && \
+	echo "${TIMEZONE}" > /etc/timezone && \
+	apk del tzdata && \
+	pip install shyaml && \
+	rm -rf /var/cache/apk/*
+
+# https://github.com/docker-library/php/issues/240
+# https://gist.github.com/guillemcanal/be3db96d3caa315b4e2b8259cab7d07e
+# https://forum.alpinelinux.org/forum/installation/php-iconv-issue
+# https://github.com/gliderlabs/docker-alpine/issues/157#issuecomment-200860301
+
+RUN apk add --no-cache --repository http://dl-cdn.alpinelinux.org/alpine/edge/testing gnu-libiconv 
+ENV LD_PRELOAD /usr/lib/preloadable_libiconv.so php
+
+RUN rm -rf /var/cache/apk/*
+
+# Set environments
+RUN sed -i "s|;*date.timezone =.*|date.timezone = ${TIMEZONE}|i" "$PHP_INI_DIR" && \
+	sed -i "s|;*memory_limit =.*|memory_limit = ${PHP_MEMORY_LIMIT}|i" "$PHP_INI_DIR" && \
+	sed -i "s|;*upload_max_filesize =.*|upload_max_filesize = ${MAX_UPLOAD}|i" "$PHP_INI_DIR" && \
+	sed -i "s|;*max_file_uploads =.*|max_file_uploads = ${PHP_MAX_FILE_UPLOAD}|i" "$PHP_INI_DIR" && \
+	sed -i "s|;*post_max_size =.*|post_max_size = ${PHP_MAX_POST}|i" "$PHP_INI_DIR" && \
+	sed -i "s|;*cgi.fix_pathinfo=.*|cgi.fix_pathinfo= 0|i" "$PHP_INI_DIR"
+
+# Update php config
+RUN mkdir -p "/etc/php7/conf.d" && \
+	echo "memory_limit=-1" > "/etc/php7/conf.d/memory-limit.ini" && \
+	echo "date.timezone=${TIMEZONE}" > "/etc/php7/conf.d/date_timezone.ini"
+
+# Setup composer
+RUN mkdir -p /composer && \
+	curl -sS https://getcomposer.org/installer | \
+	php -- --install-dir=/usr/bin/ --filename=composer
+
+COPY *.php /
+COPY *.sh /
+RUN chmod +x /*.sh
+
+ENTRYPOINT ["/entrypoint.sh"]
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 rtCamp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,2 +1,39 @@
-# action-phpcs-inspecion
-GitHub Action for PHPCS inspection.
+# PHPCS Inspections - GitHub Action
+
+A [GitHub Action](https://github.com/features/actions) that can be used to run PHPCS inspections on the diff of patch being commited.
+
+## Installation
+
+To use this GitHub Action, you must have access to GitHub Actions. GitHub Actions are currently only available in public beta (you must [apply for access](https://github.com/features/actions)).
+
+1. Create a `.github/main.workflow` in your GitHub repo.
+2. Add the following code to the `main.workflow` file and commit it to the repo's `master` branch.
+
+```bash
+workflow "PHPCS Inspections" {
+  resolves = ["Run phpcs inspection"]
+  on = "push"
+}
+
+action "Run phpcs inspection" {
+  uses = "rtCamp/rtCamp/action-phpcs-inspection@master"
+  env = {
+    DIFF_BASE="master"
+  }
+}
+
+```
+
+## Environment Variables
+
+```shell
+# To compare the committed changes between master and the current branch. Default: origin/master.
+DIFF_BASE=master
+
+# Head commit from which diff will be taken. Default: `git rev-parse HEAD`
+DIFF_HEAD=0fbe5466e1ec4eecb4bf0c7453ee4fa045ef3ebf
+```
+
+## License
+
+[MIT](LICENSE) © 2019 rtCamp
diff --git a/entrypoint.sh b/entrypoint.sh
@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+# custom path for files to override default files
+custom_path="$GITHUB_WORKSPACE/.github/inspections/codesniffer"
+main_script="/phpcs.sh"
+
+if [[ -d "$custom_path" ]]; then
+    rsync -av "$custom_path/" /
+    chmod +x /*.sh
+fi
+
+bash "$main_script"
diff --git a/filter-report-for-patch-ranges.php b/filter-report-for-patch-ranges.php
@@ -0,0 +1,70 @@
+<?php
+# Take unix/emacs reports as STDIN, such as:
+#   foo/js/bar.js:503:55: Missing radix parameter.
+# And takes a single argument pointing to the file containing the output
+# of parse-diff-ranges.php, such as:
+#   path/to/file.ext:123-456
+# And then echos the line from STDIN if the path (here, foo/js/bar.hs) exists
+# in the latter, and the line number (here 503) is among the ranges represented.
+# If there are any matches, this script will return an exit code 1.
+# If there are no matches, the script will return exit code 0.
+
+if ( empty( $argv[1] ) ) {
+	echo 'Missing argument for file containing output of parse-diff-ranges.php.';
+	exit( 2 );
+}
+if ( ! file_exists( $argv[1] ) ) {
+	echo 'Argument for file containing output of parse-diff-ranges.php does not exist.';
+	exit( 2 );
+}
+
+$matched_patch_count = 0;
+
+$parsed_diff_ranges = array();
+foreach ( explode( "\n", trim( file_get_contents( $argv[1] ) ) ) as $line ) {
+	if ( preg_match( '/^(?P<file_path>.+):(?P<start_line>\d+)-(?P<end_line>\d+)$/', $line, $matches ) ) {
+		$file_path = realpath( $matches['file_path'] );
+		if ( ! array_key_exists( $file_path, $parsed_diff_ranges ) ) {
+			$parsed_diff_ranges[ $file_path ] = array();
+		}
+		$parsed_diff_ranges[ $file_path ][] = array(
+			'start_line' => intval( $matches['start_line'] ),
+			'end_line' => intval( $matches['end_line'] ),
+		);
+	}
+}
+
+while ( $line = fgets( STDIN ) ) {
+	$matched = (
+		preg_match( '#^(?P<file_path>.+):(?P<line_number>\d+):\d+:.+$$#', $line, $matches )
+		||
+		preg_match( '/^(?P<file_path>.+): line (?P<line_number>\d+),/', $line, $matches )
+	);
+	if ( ! $matched ) {
+		continue;
+	}
+	$file_path = realpath( $matches['file_path'] );
+	if ( ! array_key_exists( $file_path, $parsed_diff_ranges ) ) {
+		continue;
+	}
+	$line_number = intval( $matches['line_number'] );
+	$matched = false;
+	foreach ( $parsed_diff_ranges[ $file_path ] as $range ) {
+		if ( $line_number >= $range['start_line'] && $line_number <= $range['end_line'] ) {
+			$matched = true;
+			break;
+		}
+	}
+	if ( ! $matched ) {
+		continue;
+	}
+
+	$matched_patch_count += 1;
+	echo $line;
+}
+
+if ( $matched_patch_count > 0 ) {
+	exit( 1 );
+} else {
+	exit( 0 );
+}
diff --git a/parse-diff-ranges.php b/parse-diff-ranges.php
@@ -0,0 +1,26 @@
+<?php
+# Take input from `git diff --no-prefix --unified=0`
+# Outputs path/to/file.ext:123-456
+# Where 123 is the start line in a diff and 456 is the end line.
+# A line appears for each patch occuring in a file.
+
+$current_file = null;
+
+while ( $line = fgets( STDIN ) ) {
+	if ( preg_match( '#^\+\+\+ (?P<file_path>.+)#', $line, $matches ) ) {
+		$current_file = $matches['file_path'];
+		$file_ranges[ $current_file ] = array();
+		continue;
+	}
+	if ( empty( $current_file ) ) {
+		continue;
+	}
+	if ( preg_match( '#^@@ -(\d+)(?:,(\d+))? \+(?P<line_number>\d+)(?:,(?P<line_count>\d+))? @@#', $line, $matches ) ) {
+		if ( empty( $matches['line_count'] ) ) {
+			$matches['line_count'] = 0;
+		}
+		$start_line = intval( $matches['line_number'] );
+		$end_line = intval( $matches['line_number'] ) + intval( $matches['line_count'] );
+		echo "$current_file:$start_line-$end_line\n";
+	}
+}
diff --git a/phpcs.sh b/phpcs.sh
@@ -0,0 +1,46 @@
+#!/usr/bin/env bash
+
+function remove_diff_range {
+  sed 's/:[0-9][0-9]*-[0-9][0-9]*$//' | sort | uniq
+}
+
+function lint_php_files {
+	PROJECT_ROOT="$(git rev-parse --show-toplevel)"
+	TEMP_DIRECTORY=$(mktemp -d 2>/dev/null || mktemp -d -t 'dev-lib')
+
+	DIFF_BASE="origin/${DIFF_BASE:-master}"
+	DIFF_HEAD=${DIFF_HEAD:-$(git rev-parse HEAD)}
+	DIFF_ARGS="$DIFF_BASE...$DIFF_HEAD"
+
+	git diff --diff-filter=AM --no-prefix --unified=0 "$DIFF_ARGS" | \
+		php /parse-diff-ranges.php | \
+		{ grep -E '\.php(:|$)' || true; } > "$TEMP_DIRECTORY/paths-scope-php"
+
+	# Setup phpcs WordPress config
+	composer global require dealerdirect/phpcodesniffer-composer-installer \
+	wp-coding-standards/wpcs 1.2.1 \
+	automattic/vipwpcs \
+	phpcompatibility/php-compatibility \
+	phpcompatibility/phpcompatibility-wp:* --update-no-dev
+
+	phpcs -i
+	if ! [[ $(cat "$TEMP_DIRECTORY/paths-scope-php") ]]; then
+		echo "No files to process"
+		return 0
+	fi
+	if ! cat "$TEMP_DIRECTORY/paths-scope-php" | remove_diff_range | xargs phpcs -s --report-emacs="$TEMP_DIRECTORY/phpcs-report" --standard="phpcs.xml"; then
+		if [ ! -s "$TEMP_DIRECTORY/phpcs-report" ]; then
+			return 1
+		else
+			cat "$TEMP_DIRECTORY/phpcs-report" | php /filter-report-for-patch-ranges.php "$TEMP_DIRECTORY/paths-scope-php" | cut -c$( expr ${#PROJECT_ROOT} + 2 )-
+			phpcs_status="${PIPESTATUS[1]}"
+			if [[ $phpcs_status != 0 ]]; then
+				return $phpcs_status
+			fi
+		fi
+	fi
+	rm -rf $TEMP_DIRECTORY
+
+}
+
+lint_php_files
