Start testing with github actions (#202)

The script `ci/test_dockerized.sh 8.0` can be used to run the exact same
tests locally.

Closes #198

Change the comment text to avoid -Wimplicit-fallthrough to avoid noise
https://developers.redhat.com/blog/2017/03/10/wimplicit-fallthrough-in-gcc-7/

Author: TysonAndre

.dockerignore

@@ -0,0 +1,40 @@
+*.dll
+*.tgz
+.deps
+*.o
+*.lo
+*.la
+*.swp
+.github
+.libs
+acinclude.m4
+aclocal.m4
+autom4te.cache
+build
+config.guess
+config.h
+config.h.in
+config.log
+config.nice
+config.status
+config.sub
+configure
+configure.in
+include
+install-sh
+libtool
+ltmain.sh
+Makefile
+Makefile.fragments
+Makefile.global
+Makefile.objects
+missing
+mkinstalldirs
+modules
+run-tests.php
+tests/*.diff
+tests/*.out
+# tests/*.php php files are used as helpers
+tests/*.exp
+tests/*.log
+tests/*.sh

.github/workflows/main.yml

@@ -0,0 +1,43 @@
+# Runs php-ast's tests and verifies that the package can be built.
+
+name: CI
+
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # See https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#using-environment-variables-in-a-matrix
+    strategy:
+      matrix:
+       include:
+         # NOTE: If this is not quoted, the yaml parser will convert 7.0 to the number 7,
+         # and the docker image `php:7` is the latest minor version of php 7.x (7.4).
+         - PHP_VERSION: '7.0'
+         - PHP_VERSION: '7.1'
+         - PHP_VERSION: '7.2'
+         - PHP_VERSION: '7.3'
+         - PHP_VERSION: '7.4'
+         - PHP_VERSION: '8.0'
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      # Runs a single command using the runners shell
+      - name: Build and test in docker
+        run: bash ci/test_dockerized.sh ${{ matrix.PHP_VERSION }}

ast.c

@@ -1331,22 +1331,22 @@ PHP_METHOD(ast_Node, __construct) {
 			if (!linenoNull) {
 				ast_update_property_long(zv, AST_STR(str_lineno), lineno, AST_CACHE_SLOT_LINENO);
 			}
-			/* break missing intentionally */
+			/* Falls through - break missing intentionally */
 		case 3:
 			if (children != NULL) {
 				ast_update_property(zv, AST_STR(str_children), children, AST_CACHE_SLOT_CHILDREN);
 			}
-			/* break missing intentionally */
+			/* Falls through - break missing intentionally */
 		case 2:
 			if (!flagsNull) {
 				ast_update_property_long(zv, AST_STR(str_flags), flags, AST_CACHE_SLOT_FLAGS);
 			}
-			/* break missing intentionally */
+			/* Falls through - break missing intentionally */
 		case 1:
 			if (!kindNull) {
 				ast_update_property_long(zv, AST_STR(str_kind), kind, AST_CACHE_SLOT_KIND);
 			}
-			/* break missing intentionally */
+			/* Falls through - break missing intentionally */
 		case 0:
 			break;
 	}

ci/Dockerfile

@@ -0,0 +1,13 @@
+ARG PHP_VERSION
+FROM php:$PHP_VERSION
+WORKDIR /php-ast
+ADD *.c *.h *.php config.m4 config.w32 package.xml LICENSE README.md ./
+
+# Assume compilation will be the time consuming step.
+# Add tests after compiling so that it's faster to update tests and re-run them locally.
+#
+# Use the same CFLAGS used to build the docker image but also check for warnings (this will emit warnings but not fail the build)
+RUN phpize && EXTRA_CFLAGS='-Wall -Wextra -Wno-unused-parameter' ./configure && make -j2 && make install
+RUN docker-php-ext-enable ast
+ADD tests ./tests
+ADD ci ./ci

ci/test_dockerized.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+if [ $# != 1 ]; then
+    echo "Usage: $0 PHP_VERSION" 1>&2
+    echo "e.g. $0 8.0 or $0 8.0-alpine" 1>&2
+    echo "The PHP_VERSION is the version of the php docker image to use" 1>&2
+    exit 1
+fi
+# -x Exit immediately if any command fails
+# -e Echo all commands being executed.
+# -u fail for undefined variables
+set -xeu
+PHP_VERSION=$1
+DOCKER_IMAGE=php-ast-$PHP_VERSION-test-runner
+docker build --build-arg="PHP_VERSION=$PHP_VERSION" --tag="$DOCKER_IMAGE" -f ci/Dockerfile .
+docker run --rm $DOCKER_IMAGE ci/test_inner.sh

ci/test_inner.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+# -x Exit immediately if any command fails
+# -e Echo all commands being executed.
+# -u fail for undefined variables
+set -xeu
+echo "Run tests in docker"
+REPORT_EXIT_STATUS=1 php ./run-tests.php -P -q --show-diff
+echo "Test that package.xml is valid"
+pecl package

package.xml

@@ -51,6 +51,7 @@
       <file name="array_destructuring_old.phpt" role="test" />
       <file name="array_destructuring.phpt" role="test" />
       <file name="assign_ops.phpt" role="test" />
+      <file name="ast_dump_with_exclude_doc.phpt" role="test" />
       <file name="ast_dump_with_linenos.phpt" role="test" />
       <file name="attributes_01.phpt" role="test" />
       <file name="attributes_02.phpt" role="test" />
@@ -62,6 +63,7 @@
       <file name="class_name_version_70.phpt" role="test" />
       <file name="class_on_objects.phpt" role="test" />
       <file name="class.phpt" role="test" />
+      <file name="class_type_85.phpt" role="test" />
       <file name="class_types.phpt" role="test" />
       <file name="closure_use_vars.phpt" role="test" />
       <file name="coalesce.phpt" role="test" />
@@ -86,6 +88,7 @@
       <file name="named_children.phpt" role="test" />
       <file name="name_node.phpt" role="test" />
       <file name="nested_stmt_lists.phpt" role="test" />
+      <file name="never_return_type.phpt" role="test" />
       <file name="node_constructor_throw.phpt" role="test" />
       <file name="nop_statements.phpt" role="test" />
       <file name="nullable_types.phpt" role="test" />
@@ -105,9 +108,10 @@
       <file name="php80_nullsafe_operator.phpt" role="test" />
       <file name="php80_promotion.phpt" role="test" />
       <file name="php80_static_type.phpt" role="test" />
-      <file name="php80_union_types.phpt" role="test" />
       <file name="php80_union_types_false.phpt" role="test" />
       <file name="php80_union_types_nullable.phpt" role="test" />
+      <file name="php80_union_types.phpt" role="test" />
+      <file name="php81_enums.phpt" role="test" />
       <file name="prop_doc_comments.phpt" role="test" />
       <file name="short_arrow_function.phpt" role="test" />
       <file name="short_arrow_function_return.phpt" role="test" />