Feature: PactV3 / VerifierV3 / MessageProvider interface (powered by pact_ffi)

.cirrus.yml

@@ -2,50 +2,56 @@ BUILD_TEST_TASK_TEMPLATE: &BUILD_TEST_TASK_TEMPLATE
   arch_check_script:
     - uname -am
   test_script:
+    - script/install_plugins.sh
     - python --version
     - python -m pip install --upgrade pip
     - python -m pip install -r requirements_dev.txt
-    - python -m flake8
+    - python -m flake8 --exclude '*pb2*',.git,__pycache__,build,dist,.tox --show-source
     - python -m pydocstyle pact
     - python -m tox -e test
-    # - make examples
+    - make todo
 
-linux_arm64_task: 
+env:
+  RUN_BROKER: 0
+  USE_HOSTED_PACT_BROKER: 1
+  USE_STANDALONE: 1
+
+PYTHON_VERSION_MATRIX: &PYTHON_VERSION_MATRIX
+  - VERSION: 3.11
+  # - VERSION: 3.6
+  # - VERSION: 3.7
+  # - VERSION: 3.8
+  # - VERSION: 3.9
+  # - VERSION: 3.10
+
+linux_arm64_task:
+  only_if: $CIRRUS_CHANGE_TITLE !=~ 'ci\(gha\).*'
   env:
+    # PACT_FFI_PATH: .tox/test/lib/python$VERSION/site-packages/pact/bin
+    LANG: C.UTF-8 # required for python 3.6 docker image
     matrix:
-      # - IMAGE: python:3.6-slim  # This works locally, with cirrus run, but fails in CI
-      - IMAGE: python:3.7-slim
-      - IMAGE: python:3.8-slim
-      - IMAGE: python:3.9-slim
-      - IMAGE: python:3.10-slim
+      <<: *PYTHON_VERSION_MATRIX
   arm_container:
-    image: $IMAGE
+    image: python:$VERSION-slim
   install_script:
-    - apt update --yes && apt install --yes gcc make
+    - apt update --yes && apt install --yes gcc make curl
   << : *BUILD_TEST_TASK_TEMPLATE
 
-
-macosx_arm64_task:
+macos_arm64_task:
+  only_if: $CIRRUS_CHANGE_TITLE !=~ 'ci\(gha\).*'
   macos_instance:
     image: ghcr.io/cirruslabs/macos-ventura-base:latest
   env:
     PATH: ${HOME}/.pyenv/shims:${PATH}
+    # PACT_FFI_PATH: .tox/test/lib/python$VERSION/site-packages/pact/bin
     matrix:
-      - PYTHON: 3.6
-      - PYTHON: 3.7
-      - PYTHON: 3.8
-      - PYTHON: 3.9
-      - PYTHON: 3.10
+      <<: *PYTHON_VERSION_MATRIX
   install_script:
-    # Per the pyenv homebrew recommendations.
-    # https://github.com/pyenv/pyenv/wiki#suggested-build-environment
-    # - xcode-select --install  # Unnecessary on Cirrus
     - brew update    
-    # - brew install openssl readline sqlite3 xz zlib 
-    - brew install pyenv
-    - pyenv install ${PYTHON}
-    - pyenv global ${PYTHON}
+    - brew install pyenv protobuf shared-mime-info # protobuf only needed if using grpc plugins
+    - pyenv install ${VERSION}
+    - pyenv global ${VERSION}
     - pyenv rehash
-  ## To install rosetta
-    # - softwareupdate --install-rosetta --agree-to-license
+    - chmod +x script/install_plugins.sh
+    - find examples -name '*.sh' -exec chmod +x {} \;
   << : *BUILD_TEST_TASK_TEMPLATE

.github/workflows/build_and_test.yml

@@ -14,18 +14,26 @@ jobs:
 
       matrix:
         python-version:
-          - '3.7'
-          - '3.8'
-          - '3.9'
-          - '3.10'
+          # - '3.7'
+          # - '3.8'
+          # - '3.9'
+          # - '3.10'
           - '3.11'
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        os: [ 
+            ubuntu-latest, 
+            windows-latest, 
+            macos-latest 
+          ]
 
         # These versions are no longer supported by Python team, and may
         # eventually be dropped from GitHub Actions.
-        include:
-          - python-version: '3.6'
-            os: ubuntu-20.04
+        # include:
+        #   - python-version: '3.6'
+        #     os: ubuntu-20.04
+        #   - python-version: '3.6'
+        #     os: windows-latest
+        #   - python-version: '3.6'
+        #     os: macos-latest
 
     steps:
       - name: Check out code
@@ -43,12 +51,29 @@ jobs:
 
       - name: Lint with flake8, pydocstyle
         run: |
-          flake8
+          flake8 --show-source --exclude '*pb2*',.git,__pycache__,build,dist,.tox
           pydocstyle pact
 
+      - name: Install Pact plugins for tests
+        run: script/install_plugins.sh
+        shell: bash
+
       - name: Test with pytest
         run: tox -e test
+        # env:
+        #   PACT_FFI_PATH: .tox/test/lib/python${{ matrix.python-version }}/site-packages/pact/bin
 
       - name: Test examples
         if: runner.os == 'Linux'
-        run: make examples
+        run: make todo
+
+      - name: Test examples
+      # no docker so we use a hosted pact broker and pact-ruby-standalone for publishing
+        if: runner.os != 'Linux'
+        run: make todo
+        env:
+          RUN_BROKER: 0
+          USE_HOSTED_PACT_BROKER: 1
+          USE_STANDALONE: 1
+          PACT_LOG_LEVEL: DEBUG   
+          PACT_LOG_OUTPUT: STDOUT

.gitignore

@@ -1,7 +1,7 @@
 # pact-python specific ignores
 e2e/pacts
-userserviceclient-userservice.json
-detectcontentlambda-contentprovider.json
+# userserviceclient-userservice.json # unexcluded for cirrus ci locally
+# detectcontentlambda-contentprovider.json # unexcluded for cirrus ci locally
 pact/bin
 
 # Byte-compiled / optimized / DLL files
@@ -10,7 +10,7 @@ __pycache__/
 *$py.class
 
 # C extensions
-*.so
+# *.so
 
 # Distribution / packaging
 .Python
@@ -91,6 +91,7 @@ celerybeat-schedule
 venv/
 .venv/
 ENV/
+.venv/
 
 # Spyder project settings
 .spyderproject
@@ -105,3 +106,7 @@ ENV/
 
 .noseids
 
+# MacOS stuff
+.DS_Store
+# Generated pact directories
+# /pacts/

MANIFEST

@@ -18,14 +18,21 @@ pact/message_consumer.py
 pact/message_pact.py
 pact/message_provider.py
 pact/pact.py
+pact/pact_exception.py
 pact/provider.py
 pact/verifier.py
 pact/verify_wrapper.py
+pact/bin/libpact_ffi-linux-aarch64.so.gz
+pact/bin/libpact_ffi-linux-x86_64.so.gz
+pact/bin/libpact_ffi-osx-aarch64-apple-darwin.dylib.gz
+pact/bin/libpact_ffi-osx-x86_64.dylib.gz
 pact/bin/pact-2.0.3-linux-arm64.tar.gz
 pact/bin/pact-2.0.3-linux-x86_64.tar.gz
 pact/bin/pact-2.0.3-osx-arm64.tar.gz
 pact/bin/pact-2.0.3-osx-x86_64.tar.gz
 pact/bin/pact-2.0.3-windows-x86.zip
 pact/bin/pact-2.0.3-windows-x86_64.zip
+pact/bin/pact.h
+pact/bin/pact_ffi-windows-x86_64.dll.gz
 pact/cli/__init__.py
 pact/cli/verify.py

Makefile

@@ -16,6 +16,8 @@ help:
 	@echo "  fastapi    to run the example FastApi provider tests"
 	@echo "  flask      to run the example Flask provider tests"
 	@echo "  messaging  to run the example messaging e2e tests"
+	@echo "  grpc       to run the example grpc e2e tests"
+	@echo "  todo		to run the example todo tests"
 	@echo "  package    to create a distribution package in /dist/"
 	@echo "  release    to perform a release build, including deps, test, and package targets"
 	@echo "  test       to run all tests"
@@ -78,6 +80,24 @@ define MESSAGING
 endef
 export MESSAGING
 
+define GRPC
+	echo "grpc make"
+	cd examples/grpc
+	pip install -q -r requirements.txt
+	pip install -e ../../
+	./run_pytest.sh
+endef
+export GRPC
+
+define TODO
+	echo "todo make"
+	cd examples/todo
+	pip install -r requirements.txt
+	pip install -e ../../
+	./run_pytest.sh
+endef
+export TODO
+
 
 .PHONY: consumer
 consumer:
@@ -98,9 +118,18 @@ fastapi:
 messaging:
 	bash -c "$$MESSAGING"
 
+.PHONY: grpc
+grpc:
+	bash -c "$$GRPC"
+
+.PHONY: todo
+todo:
+	bash -c "$$TODO"
+
 
 .PHONY: examples
-examples: consumer flask fastapi messaging
+examples: consumer flask fastapi messaging grpc todo
+# examples: consumer flask fastapi messaging todo
 
 
 .PHONY: package
@@ -110,7 +139,7 @@ package:
 
 .PHONY: test
 test: deps
-	flake8
+	flake8 --exclude examples/area_calculator/area_calculator_pb2.py,examples/area_calculator/area_calculator_pb2_grpc.py
 	pydocstyle pact
 	coverage erase
 	tox

README.md

@@ -17,17 +17,19 @@ Note: As of Version 1.0 deprecates support for python 2.7 to allow us to incorpo
 # How to use pact-python
 
 ## Installation
+
 ```
 pip install pact-python
 ```
 
 ## Getting started
+
 <!-- Absolute link for rendering page in docs.pact.io -->
 A guide follows but if you go to the [examples](https://github.com/pact-foundation/pact-python/tree/master/examples). This has a consumer, provider and pact-broker set of tests for both FastAPI and Flask.
 
 ## Writing a Pact
 
-Creating a complete contract is a two step process:
+Creating a complete contract is a two-step process:
 
 1. Create a test on the consumer side that declares the expectations it has of the provider
 2. Create a provider state that allows the contract to pass when replayed against the provider
@@ -82,7 +84,6 @@ class GetUserInfoContract(unittest.TestCase):
       result = user('UserA')
 
     self.assertEqual(result, expected)
-
 ```
 
 This does a few important things:
@@ -164,11 +165,13 @@ The mock service offers you several important features when building your contra
 - Finally, it will record your contracts as a JSON file that you can store in your repository or publish to a Pact broker.
 
 ## Expecting Variable Content
+
 The above test works great if that user information is always static, but what happens if
 the user has a last updated field that is set to the current time every time the object is
 modified? To handle variable data and make your tests more robust, there are 3 helpful matchers:
 
 ### Term(matcher, generate)
+
 Asserts the value should match the given regular expression. You could use this
 to expect a timestamp with a particular format in the request or response where
 you know you need a particular format, but are unconcerned about the exact date:
@@ -194,6 +197,7 @@ provider, the regex will be used to search the response from the real provider s
 and the test will be considered successful if the regex finds a match in the response.
 
 ### Like(matcher)
+
 Asserts the element's type matches the matcher. For example:
 
 ```python
@@ -202,6 +206,7 @@ Like(123)  # Matches if the value is an integer
 Like('hello world')  # Matches if the value is a string
 Like(3.14)  # Matches if the value is a float
 ```
+
 The argument supplied to `Like` will be what the mock service responds with.
 
 When a dictionary is used as an argument for Like, all the child objects (and their child objects etc.) will be matched according to their types, unless you use a more specific matcher like a Term.
@@ -453,7 +458,8 @@ The provider application version. Required for publishing verification results.
 Publish verification results to the broker.
 
 ### Python API
-You can use the Verifier class. This allows you to write native python code and the test framework of your choice.
+
+You can use the Verifier class. This has all the same parameters as the cli tool but allows you to write native python code and the test framework of your choice.
 
 ```python
 verifier = Verifier(provider='UserService',
@@ -507,6 +513,7 @@ You can see more details in the examples
 - [FastAPI Provider Verifier Test](https://github.com/pact-foundation/pact-python/tree/master/examples/fastapi_provider/tests/provider/test_provider.py)
 
 ### Provider States
+
 In many cases, your contracts will need very specific data to exist on the provider
 to pass successfully. If you are fetching a user profile, that user needs to exist,
 if querying a list of records, one or more records needs to exist. To support
@@ -525,18 +532,20 @@ on the provider application or a separate one. Some strategies for managing stat
 For more information about provider states, refer to the [Pact documentation] on [Provider States].
 
 # Development
+
 <!-- Absolute link for rendering page in docs.pact.io -->
 Please read [CONTRIBUTING.md](https://github.com/pact-foundation/pact-python/blob/master/CONTRIBUTING.md)
 
 To setup a development environment:
 
-1. If you want to run tests for all Python versions, install 2.7, 3.3, 3.4, 3.5, and 3.6 from source or using a tool like [pyenv]
-2. Its recommended to create a Python [virtualenv] for the project
+1. If you want to run tests for all Python versions, install 3.6, 3.7, 3.8, and 3.9 from source or using a tool like [pyenv]
+2. It's recommended to create a Python [virtualenv] for the project.
+3. We are now using FFI bindings. For mac you might want to read these [setup FFI](https://cffi.readthedocs.io/en/latest/installation.html)
 
 To setup the environment, run tests, and package the application, run:
 `make release`
 
-If you are just interested in packaging pact-python so you can install it using pip:
+If you are just interested in packaging pact-python you can install it using pip:
 
 `make package`