PHP SDK integration

.github/workflows/all-docker-images.yaml

@@ -14,7 +14,7 @@ on:
         description: Python SDK ver to build. Skipped if not specified. Must start with v.
         type: string
       php-ver:
-        description: PHP SDK ver to build. Skipped if not specified.
+        description: PHP SDK ver to build. Skipped if not specified. Must start with v.
         type: string
       ts-ver:
         description: TypeScript SDK ver to build. Skipped if not specified. Must start with v.

.github/workflows/ci.yaml

@@ -16,6 +16,9 @@ on: # rebuild any PRs and main branch changes
       java_sdk_version:
         default: ''
         type: string
+      php_sdk_version:
+        default: ''
+        type: string
       python_sdk_version:
         default: ''
         type: string
@@ -39,6 +42,7 @@ jobs:
       go_latest: ${{ steps.latest_version.outputs.go_latest }}
       typescript_latest: ${{ steps.latest_version.outputs.typescript_latest }}
       java_latest: ${{ steps.latest_version.outputs.java_latest }}
+      php_latest: ${{ steps.latest_version.outputs.php_latest }}
       python_latest: ${{ steps.latest_version.outputs.python_latest }}
       csharp_latest: ${{ steps.latest_version.outputs.csharp_latest }}
     steps:
@@ -75,6 +79,13 @@ jobs:
           fi
           echo "java_latest=$java_latest" >> $GITHUB_OUTPUT
 
+          php_latest="${{ github.event.inputs.php_sdk_version }}"
+          if [ -z "$php_latest" ]; then
+            php_latest=$(./temporal-features latest-sdk-version --lang php)
+            echo "Derived latest PHP SDK release version: $php_latest"
+          fi
+          echo "php_latest=$php_latest" >> $GITHUB_OUTPUT
+
           python_latest="${{ github.event.inputs.python_sdk_version }}"
           if [ -z "$python_latest" ]; then
             python_latest=$(./temporal-features latest-sdk-version --lang py)
@@ -122,6 +133,23 @@ jobs:
       - run: poetry install --no-root
       - run: poe lint
 
+  build-php:
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Print build information
+        run: 'echo head_ref: "$GITHUB_HEAD_REF", ref: "$GITHUB_REF", os: ${{ matrix.os }}'
+      - uses: actions/checkout@v4
+      - name: Setup PHP 8.2
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          tools: composer:v2
+          extensions: dom, sockets, grpc, curl, protobuf
+
   build-java:
     strategy:
       fail-fast: true
@@ -182,6 +210,15 @@ jobs:
       features-repo-ref: ${{ github.head_ref }}
       features-repo-path: ${{ github.event.pull_request.head.repo.full_name }}
 
+  feature-tests-php:
+    needs: build-go
+    uses: ./.github/workflows/php.yaml
+    with:
+      version: ${{ needs.build-go.outputs.php_latest }}
+      version-is-repo-ref: false
+      features-repo-ref: ${{ github.head_ref }}
+      features-repo-path: ${{ github.event.pull_request.head.repo.full_name }}
+
   feature-tests-java:
     needs: build-go
     uses: ./.github/workflows/java.yaml
@@ -209,6 +246,6 @@ jobs:
       go-ver: 'v${{ needs.build-go.outputs.go_latest }}'
       ts-ver: 'v${{ needs.build-go.outputs.typescript_latest }}'
       java-ver: 'v${{ needs.build-go.outputs.java_latest }}'
-      php-ver: '${{ needs.build-go.outputs.php_latest }}'
+      php-ver: 'v${{ needs.build-go.outputs.php_latest }}'
       py-ver: 'v${{ needs.build-go.outputs.python_latest }}'
       cs-ver: 'v${{ needs.build-go.outputs.csharp_latest }}'

.github/workflows/docker-images.yaml

@@ -65,6 +65,8 @@ jobs:
 
       # This step will set the FEATURES_BUILT_IMAGE_TAG env key
       - name: Build docker image
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           go run . build-image --lang ${{ inputs.lang }} \
           ${{ inputs.sdk-repo-ref && format('--repo-ref {0}', inputs.sdk-repo-ref) || '' }} \

.github/workflows/php.yaml

@@ -0,0 +1,101 @@
+name: PHP Features Testing
+on:
+  workflow_call:
+    inputs:
+      php-repo-path:
+        type: string
+        default: 'temporal/sdk'
+      version:
+        required: true
+        type: string
+      # When true, the default version will be used (actually it's the latest tag)
+      version-is-repo-ref:
+        required: true
+        type: boolean
+      features-repo-path:
+        type: string
+        default: 'temporalio/features'
+      features-repo-ref:
+        type: string
+        default: 'main'
+      # If set, download the docker image for server from the provided artifact name
+      docker-image-artifact-name:
+        type: string
+        required: false
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    defaults:
+      run:
+        working-directory: ./features
+    steps:
+      - name: Print git info
+        run: 'echo head_ref: "$GITHUB_HEAD_REF", ref: "$GITHUB_REF", PHP sdk version: ${{ inputs.version }}'
+        working-directory: '.'
+
+      - name: Download docker artifacts
+        if: ${{ inputs.docker-image-artifact-name }}
+        uses: actions/download-artifact@v3
+        with:
+          name: ${{ inputs.docker-image-artifact-name }}
+          path: /tmp/server-docker
+
+      - name: Load server Docker image
+        if: ${{ inputs.docker-image-artifact-name }}
+        run: docker load --input /tmp/server-docker/temporal-autosetup.tar
+        working-directory: '.'
+
+      - name: Override IMAGE_TAG environment variable
+        if: ${{ inputs.docker-image-artifact-name }}
+        run: |
+          image_tag=latest
+          # image_tag won't exist on older builds (like 1.22.0), so default to latest
+          if [ -f /tmp/server-docker/image_tag ]; then
+            image_tag=$(cat /tmp/server-docker/image_tag)
+          fi
+          echo "IMAGE_TAG=${image_tag}" >> $GITHUB_ENV
+        working-directory: '.'
+
+      - name: Checkout SDK features repo
+        uses: actions/checkout@v4
+        with:
+          path: features
+          repository: ${{ inputs.features-repo-path }}
+          ref: ${{ inputs.features-repo-ref }}
+
+      - uses: actions/setup-go@v2
+        with:
+          go-version: '^1.22'
+      - name: Setup PHP 8.2
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          tools: composer:v2
+          extensions: dom, sockets, grpc, curl, protobuf
+      - name: Start containerized server and dependencies
+        if: inputs.docker-image-artifact-name
+        run: |
+          docker compose \
+            -f ./dockerfiles/docker-compose.for-server-image.yaml \
+            -f /tmp/server-docker/docker-compose.yml \
+            up -d temporal-server cassandra elasticsearch
+
+      - name: Run SDK-features tests directly
+        if: inputs.docker-image-artifact-name == ''
+        run: go run . run --lang php ${{ inputs.docker-image-artifact-name && '--server localhost:7233 --namespace default' || ''}} --version "${{ inputs.version-is-repo-ref && '' || inputs.version }}"
+
+      # Running the tests in their own step keeps the logs readable
+      - name: Run containerized SDK-features tests
+        if: inputs.docker-image-artifact-name
+        run: |
+          docker compose \
+            -f ./dockerfiles/docker-compose.for-server-image.yaml \
+            -f /tmp/server-docker/docker-compose.yml \
+            up --no-log-prefix --exit-code-from features-tests-php features-tests-php
+
+      - name: Tear down docker compose
+        if: inputs.docker-image-artifact-name && (success() || failure())
+        run: docker compose -f ./dockerfiles/docker-compose.for-server-image.yaml -f /tmp/server-docker/docker-compose.yml down -v

README.md

@@ -17,7 +17,7 @@ These features serve several purposes:
 With latest [Go](https://golang.org/) installed, run:
 
 ```
-go build -o temporal-features # or temporal-features.exec on Windows
+go build -o temporal-features # or temporal-features.exe on Windows
 ```
 
 ## Running
@@ -31,14 +31,16 @@ Prerequisites:
   - [Poetry](https://python-poetry.org/): `poetry install`
   - `setuptools`: `python -m pip install -U setuptools`
 - [.NET](https://dotnet.microsoft.com) 7+
+- [PHP](https://www.php.net/) 8.1+
+  - [Composer](https://getcomposer.org/)
 
 Command:
 
     temporal-features run --lang LANG [--version VERSION] [PATTERN...]
 
 Note, `go run .` can be used in place of `go build` + `temporal-features` to save on the build step.
 
-`LANG` can be `go`, `java`, `ts`, `py`, or `cs`. `VERSION` is per SDK and if left off, uses the latest version set for
+`LANG` can be `go`, `java`, `ts`, `php`, `py`, or `cs`. `VERSION` is per SDK and if left off, uses the latest version set for
 the language in this repository.
 
 `PATTERN` must match either the features relative directory _or_ the relative directory + `/feature.<ext>` via

cmd/prepare.go

@@ -90,6 +90,8 @@ func (p *Preparer) Prepare(ctx context.Context) error {
 		_, err = p.BuildJavaProgram(ctx, true)
 	case "ts":
 		_, err = p.BuildTypeScriptProgram(ctx)
+	case "php":
+		_, err = p.BuildPhpProgram(ctx)
 	case "py":
 		_, err = p.BuildPythonProgram(ctx)
 	case "cs":

cmd/run.go

@@ -295,6 +295,16 @@ func (r *Runner) Run(ctx context.Context, patterns []string) error {
 		if err == nil {
 			err = r.RunTypeScriptExternal(ctx, run)
 		}
+	case "php":
+		if r.config.DirName != "" {
+			r.program, err = sdkbuild.PhpProgramFromDir(
+				filepath.Join(r.rootDir, r.config.DirName),
+				r.rootDir,
+			)
+		}
+		if err == nil {
+			err = r.RunPhpExternal(ctx, run)
+		}
 	case "py":
 		if r.config.DirName != "" {
 			r.program, err = sdkbuild.PythonProgramFromDir(filepath.Join(r.rootDir, r.config.DirName))
@@ -545,7 +555,7 @@ func (r *Runner) destroyTempDir() {
 func normalizeLangName(lang string) (string, error) {
 	// Normalize to file extension
 	switch lang {
-	case "go", "java", "ts", "py", "cs":
+	case "go", "java", "ts", "php", "py", "cs":
 	case "typescript":
 		lang = "ts"
 	case "python":
@@ -561,7 +571,7 @@ func normalizeLangName(lang string) (string, error) {
 func expandLangName(lang string) (string, error) {
 	// Expand to lang name
 	switch lang {
-	case "go", "java", "typescript", "python":
+	case "go", "java", "typescript", "php", "python":
 	case "ts":
 		lang = "typescript"
 	case "py":

cmd/run_php.go

@@ -0,0 +1,77 @@
+package cmd
+
+import (
+	"context"
+	"fmt"
+	"path/filepath"
+	"github.com/temporalio/features/harness/go/cmd"
+	"github.com/temporalio/features/sdkbuild"
+)
+
+// PreparePhpExternal prepares a PHP run without running it. The preparer
+// config directory if present is expected to be a subdirectory name just
+// beneath the root directory.
+func (p *Preparer) BuildPhpProgram(ctx context.Context) (sdkbuild.Program, error) {
+	p.log.Info("Building PHP project", "DirName", p.config.DirName)
+
+	prog, err := sdkbuild.BuildPhpProgram(ctx, sdkbuild.BuildPhpProgramOptions{
+		DirName: p.config.DirName,
+		Version: p.config.Version,
+		RootDir: p.rootDir,
+	})
+	if err != nil {
+		p.log.Error("failed preparing: %w", err)
+		return nil, fmt.Errorf("failed preparing: %w", err)
+	}
+	return prog, nil
+}
+
+// RunPhpExternal runs the PHP run in an external process. This expects
+// the server to already be started.
+func (r *Runner) RunPhpExternal(ctx context.Context, run *cmd.Run) error {
+	// If program not built, build it
+	if r.program == nil {
+		var err error
+		if r.program, err = NewPreparer(r.config.PrepareConfig).BuildPhpProgram(ctx); err != nil {
+			return err
+		}
+	}
+
+	// Compose RoadRunner command options
+	args := append(
+		[]string{
+			// Namespace
+			"namespace=" + r.config.Namespace,
+			// Server address
+			"address=" + r.config.Server,
+		},
+		// Features
+		run.ToArgs()...,
+	)
+	// TLS
+	if r.config.ClientCertPath != "" {
+		clientCertPath, err := filepath.Abs(r.config.ClientCertPath)
+		if err != nil {
+			return err
+		}
+		args = append(args, "tls.cert="+clientCertPath)
+	}
+	if r.config.ClientKeyPath != "" {
+		clientKeyPath, err := filepath.Abs(r.config.ClientKeyPath)
+		if err != nil {
+			return err
+		}
+		args = append(args, "tls.key="+clientKeyPath)
+	}
+
+	// Run
+	cmd, err := r.program.NewCommand(ctx, args...)
+	if err == nil {
+		// r.log.Debug("Running PHP separately", "Args", cmd.Args)
+		err = cmd.Run()
+	}
+	if err != nil {
+		return fmt.Errorf("failed running: %w", err)
+	}
+	return nil
+}

dockerfiles/docker-compose.for-server-image.yaml

@@ -69,3 +69,13 @@ services:
       - temporal-server
     networks:
       - temporal-dev-network
+
+  features-tests-php:
+    image: temporaliotest/features:php
+    environment:
+      - WAIT_EXTRA_FOR_NAMESPACE
+    command: ['--server', 'temporal-server:7233', '--namespace', 'default']
+    depends_on:
+      - temporal-server
+    networks:
+      - temporal-dev-network

dockerfiles/php.Dockerfile

@@ -1,20 +1,16 @@
 # Build in a full featured container
-FROM php:8.2 as build
+FROM php:8.2-cli as build
 
 # Install protobuf compiler
 RUN apt-get update \
  && DEBIAN_FRONTEND=noninteractive \
     apt-get install --no-install-recommends --assume-yes \
-      protobuf-compiler=3.* libprotobuf-dev=3.* wget=*
+      protobuf-compiler=3.* libprotobuf-dev=3.* wget=* git=*
 
 # Get go compiler
 ARG PLATFORM=amd64
-RUN wget -q https://go.dev/dl/go1.22.4.linux-${PLATFORM}.tar.gz \
-    && tar -C /usr/local -xzf go1.22.4.linux-${PLATFORM}.tar.gz
-# Install Rust for compiling the core bridge - only required for installation from a repo but is cheap enough to install
-# in the "build" container (-y is for non-interactive install)
-# hadolint ignore=DL4006
-RUN wget -q -O - https://sh.rustup.rs | sh -s -- -y
+RUN wget -q https://go.dev/dl/go1.22.5.linux-${PLATFORM}.tar.gz \
+    && tar -C /usr/local -xzf go1.22.5.linux-${PLATFORM}.tar.gz
 
 # Install composer
 COPY --from=composer:2.3 /usr/bin/composer /usr/bin/composer