Add CI

.buildkite/hooks/post-command

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+# Only run this on AWS agents
+if [[ -z "${BUILDKITE_AGENT_META_DATA_AWS_REGION}" ]]; then
+	exit 0
+fi
+
+mkdir -p logs
+
+echo "--- :docker: Saving Docker Logs"
+docker-compose logs wpcli > logs/wpcli.log
+docker-compose logs wordpress > logs/wordpress.log
+docker-compose logs mysql > logs/mysql.log
+
+buildkite-agent artifact upload "logs/*.log"

.buildkite/pipeline.yml

@@ -0,0 +1,79 @@
+# Nodes with values to reuse in the pipeline.
+common_params:
+  plugins: &common_plugins
+    - automattic/a8c-ci-toolkit#2.17.0
+  # Common environment values to use with the `env` key.
+
+steps:
+  #
+  # Rust Group
+  - group: ":rust: Core Library"
+    key: "rust"
+    steps:
+      - label: ":rust: Build and Test"
+        command: |
+          echo "--- :rust: Building + Testing"
+          make test-rust
+      - label: ":rust: Lint"
+        command: |
+          echo "--- :rust: Running Clippy"
+          make lint-rust
+  #
+  # Swift Group
+  - group: ":swift: Swift Wrapper"
+    key: "swift"
+    steps:
+      - label: ":swift: Build and Test"
+        command: |
+          echo "--- :rust: Installing Rust"
+          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -v -y
+
+          source "/Users/builder/.cargo/env"
+
+          echo "--- :package: Installing Rust Toolchains"
+          rustup target add x86_64-apple-ios
+          rustup target add aarch64-apple-ios
+          rustup target add aarch64-apple-darwin
+          rustup target add x86_64-apple-darwin
+          rustup target add aarch64-apple-ios-sim
+
+          rustup toolchain install nightly
+          rustup component add rust-src --toolchain nightly-aarch64-apple-darwin
+
+          echo "--- :swift: Building + Testing"
+          make test-swift
+        env:
+          IMAGE_ID: xcode-15.2
+        plugins: *common_plugins
+        agents:
+          queue: mac
+      - label: ":swift: Lint"
+        command: |
+          echo "--- :swift: Swiftlint"
+          make lint-swift
+  #
+  # Docker Group
+  - group: ":wordpress: End-to-end Tests"
+    key: "e2e"
+    steps:
+      - label: ":wordpress: WordPress {{matrix}}"
+        command: |
+          echo "--- :docker: Setting up Test Server"
+          make test-server
+
+          echo "--- 🧪 Running Tests"
+          curl -u test@example.com:$(cat test_credentials) 'http://localhost/wp-json/wp/v2/posts?context=edit' --fail-with-body | jq
+        env:
+          WORDPRESS_VERSION: "{{matrix}}"
+        matrix:
+          - '6.4'
+          - '6.3'
+          - '6.2'
+          - '6.1'
+          - '6.0'
+          - '5.9'
+          - '5.8'
+          - '5.7'
+          - '5.6' # First version to introduce appliation passwords
+
+

.buildkite/setup-test-site.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+set -e
+
+# This script sets up a WordPress test site on the `wordpress` docker image. 
+# You might wonder "why not do this work once, then just import the database for each run?"
+# We do each step each time for each build because we're trying to get a "mint" condition site
+# for each WordPress version – if there are issues with DB migrations, different default themes
+# available, etc we don't want to have to deal with them.
+
+## Install WordPress
+wp core download --force
+
+wp core install \
+	--url=localhost \
+	--title=my-test-site \
+	--admin_user=test@example.com \
+	--admin_email=test@example.com \
+	--admin_password=strongpassword \
+	--skip-email
+
+## Ensure URLs work as expected
+wp rewrite structure '/%year%/%monthnum%/%postname%/'
+
+## Download the sample data (https://codex.wordpress.org/Theme_Unit_Test)
+curl https://raw.githubusercontent.com/WPTT/theme-unit-test/master/themeunittestdata.wordpress.xml -C - -o /tmp/testdata.xml
+
+## Then install the importer plugin
+wp plugin install wordpress-importer --activate
+
+## Then install the test data (https://developer.wordpress.org/cli/commands/import/)
+wp import /tmp/testdata.xml --authors=create
+
+## Then clean up the importer plugin
+wp plugin delete wordpress-importer
+
+## Create an Application password for the admin user, and store it where it can be used by the test suite
+wp user application-password create test@example.com test --porcelain >> /tmp/test_credentials

.gitignore

@@ -24,5 +24,10 @@ local.properties
 # Auto-generated Swift Files
 native/swift/Sources/wordpress-api-wrapper/*.swift
 
-# Temporary test credentials
+# Test Server
+.wordpress
 test_credentials
+/logs
+
+# CI Cache
+.cargo

.swiftlint.yml

@@ -0,0 +1,6 @@
+swiftlint_version: 0.53.0
+excluded: # paths to ignore during linting. Takes precedence over `included`.
+  - .cargo                                                  # Local Cargo cache
+  - .build                                                  # Compiled Code
+  - native/swift/Sources/wordpress-api-wrapper/wp_api.swift # auto-generated code
+  - target                                                  # Compiled Code

Makefile

@@ -7,7 +7,11 @@ udl_path := wp_api/src/wp_api.udl
 docker_container_repo_dir=/app
 
 # Common docker options
+rust_docker_container := public.ecr.aws/docker/library/rust:1.76
+swiftlint_container := ghcr.io/realm/swiftlint:0.53.0
+
 docker_opts_shared :=  --rm -v "$(PWD)":$(docker_container_repo_dir) -w $(docker_container_repo_dir)
+rust_docker_run := docker run -v $(PWD):/$(docker_container_repo_dir) -w $(docker_container_repo_dir) -it -e CARGO_HOME=/app/.cargo $(rust_docker_container)
 docker_build_and_run := docker build -t foo . && docker run $(docker_opts_shared) -it foo
 
 clean:
@@ -147,6 +151,32 @@ test-android: bindings _test-android
 
 publish-android-local: bindings _publish-android-local
 
+test-rust:
+	$(rust_docker_run) cargo test
+
+test-server:
+	rm -rf test_credentials && touch test_credentials && chmod 777 test_credentials
+	docker-compose up -d
+	docker-compose run wpcli
+
+stop-server:
+	docker-compose down
+
+lint: lint-rust lint-swift
+
+lint-rust:
+	$(rust_docker_run) /bin/bash -c "rustup component add clippy && cargo clippy --all -- -D warnings"
+
+lint-swift:
+	docker run -v $(PWD):$(docker_container_repo_dir) -w $(docker_container_repo_dir) -it $(swiftlint_container) swiftlint
+
+lintfix-swift:
+	docker run -v $(PWD):$(docker_container_repo_dir) -w $(docker_container_repo_dir) -it $(swiftlint_container) swiftlint --autocorrect
+
 build-in-docker:
 	$(call bindings)
 	$(docker_build_and_run)
+
+dev-server:
+	mkdir -p .wordpress
+	docker-compose up

Package.swift

@@ -23,7 +23,7 @@ let package = Package(
         .target(
             name: "wordpress-api",
             dependencies: [
-                .target(name: "wordpress-api-wrapper"),
+                .target(name: "wordpress-api-wrapper")
             ],
             path: "native/swift/Sources/wordpress-api"
         ),

docker-compose.yml

@@ -0,0 +1,61 @@
+version: '3'
+services:
+    wordpress:
+        image: 'public.ecr.aws/docker/library/wordpress:${WORDPRESS_VERSION:-latest}'
+        ports:
+            - '80:80'
+        volumes:
+            - .wordpress:/var/www/html
+        environment:
+            WORDPRESS_DB_HOST: mysql
+            WORDPRESS_DB_USER: wordpress
+            WORDPRESS_DB_PASSWORD: wordpress
+            WORDPRESS_DB_NAME: wordpress
+            WORDPRESS_CONFIG_EXTRA: |
+                # Allow application passwords to be used without HTTPS
+                define( 'WP_ENVIRONMENT_TYPE', 'local' );
+
+        depends_on:
+            mysql:
+                condition: service_healthy
+        healthcheck:
+            test: ["CMD", "bash" ,"-c", "[ -f /var/www/html/wp-config.php ]"]
+            interval: 4s
+            timeout: 1s
+            retries: 30
+
+    wpcli:
+        image: 'public.ecr.aws/docker/library/wordpress:cli'
+        user: 33:33 # Fixes permissions issues with writing files
+        volumes:
+            - ./.buildkite/setup-test-site.sh:/setup-test-site.sh:ro
+            - ./.wordpress/wp-config.php:/var/www/html/wp-config.php:ro
+            - ./test_credentials:/tmp/test_credentials
+        environment:
+            WORDPRESS_DB_HOST: mysql
+            WORDPRESS_DB_USER: wordpress
+            WORDPRESS_DB_PASSWORD: wordpress
+            WORDPRESS_DB_NAME: wordpress
+        depends_on:
+            mysql:
+                condition: service_healthy
+            wordpress:
+                condition: service_healthy
+        entrypoint: ["/setup-test-site.sh"]
+        profiles:
+            - donotstart
+
+    mysql:
+        image: 'public.ecr.aws/docker/library/mysql:8.0'
+        ports:
+            - '3306:3306'
+        environment:
+            MYSQL_DATABASE: 'wordpress'
+            MYSQL_USER: 'wordpress'
+            MYSQL_PASSWORD: 'wordpress'
+            MYSQL_RANDOM_ROOT_PASSWORD: true
+        healthcheck:
+            test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost"]
+            interval: 4s
+            timeout: 1s
+            retries: 30

native/swift/Sources/wordpress-api/Posts/API+ListPosts.swift

@@ -7,15 +7,14 @@ extension WordPressAPI {
 
     /// Fetch a list of posts
     ///
-    /// If you're only interested in fetching a specific page, this is a good method for that – if you want to sync all records, consider using the
-    /// overload of this method that returns `PostObjectSequence`.
+    /// If you're only interested in fetching a specific page, this is a good method for that – if you
+    /// want to sync all records,  consider using the overload of this method that returns `PostObjectSequence`.
     public func listPosts(params: PostListParams = PostListParams()) async throws -> PostListResponse {
         let request = self.helper.postListRequest(params: params)
         let response = try await perform(request: request)
         return try parsePostListResponse(response: response)
     }
 
-
     /// A good way to fetch every post (you can still specify a specific offset using `params`)
     ///
     public func listPosts(params: PostListParams = PostListParams()) -> PostObjectSequence {

native/swift/Sources/wordpress-api/Posts/Post Collections.swift

@@ -2,9 +2,11 @@ import Foundation
 import wordpress_api_wrapper
 
 extension PostObject: Identifiable {
+    // swiftlint:disable identifier_name
     var ID: any Hashable {
         self.id
     }
+    // swiftlint:enable identifier_name
 }
 
 public typealias PostCollection = [PostObject]
@@ -17,6 +19,10 @@ public struct PostObjectSequence: AsyncSequence, AsyncIteratorProtocol {
     private var posts: [PostObject] = []
     private var nextPage: WpNetworkRequest?
 
+    enum Errors: Error {
+        case unableToFetchPosts
+    }
+
     init(api: WordPressAPI, initialParams: PostListParams) {
         self.api = api
         self.nextPage = api.helper.postListRequest(params: initialParams)
@@ -41,7 +47,7 @@ public struct PostObjectSequence: AsyncSequence, AsyncIteratorProtocol {
         if let postList = parsedResponse.postList {
             self.posts.append(contentsOf: postList)
         } else {
-            abort() // TODO: Not sure if this should be an error
+            throw Errors.unableToFetchPosts
         }
 
         if let nextPageUri = parsedResponse.nextPage {