sgleadow
2018-05-10 21:09
Question about running pact tests from an iOS build... we've been using the _pre-actions_ and _post-actions_ of the scheme in the Xcode project to start/stop the pact, and then upload to the broker:
*pre-actions*
```
"${PACT_BIN}/pact-mock-service" start --pact-specification-version 2.0.0 --log "${SRCROOT}/tmp/pact.log" --pact-dir "${SRCROOT}/tmp/pacts" -p 1234
```
*post-actions*
```
"${PACT_BIN}/pact-mock-service" stop
```
and
```
"${PACT_BIN}/pact-broker" publish "${SRCROOT}/tmp/pacts" --consumer-app-version=1.0.1 --tag master
```
What I'm seeing is that, non-zero exit codes from these scripts don't result in the actual build being marked as an error or failure by Xcode, so it won't actually fail CI.
How to you get around this? Does Xcode want you to print some special error message to mark it as failed?
marko
2018-05-11 01:15
@sgleadow quick look into it confirms that `xcodebuild` doesn?t report results of pre/post action scripts. Will look into this a bit further. If you happen to come up with a workaround, please share.
marko
2018-05-11 01:17
@sgleadow a though, if you?d log the result of pre/post actions into a file, then in Build Step run a script (jeez!) to check for the result?
sgleadow
2018-05-11 01:17
If it's a build phase script, rather than a scheme pre/post script, it respects exit codes and I think there's a format to print warnings/errors
sgleadow
2018-05-11 01:18
Although, that works for compiling, not sure it works for Test runs anymore, as that's not just a build script any more
marko
2018-05-11 01:20
these guys had a similar problem? https://forums.developer.apple.com/thread/30726
sgleadow
2018-05-11 01:22
Yeah that's the exact same mechanism and shows how it would work in a build phase, but the way RunUnitTests works has changed since that post I believe.
marko
2018-05-11 01:24
Will put it on the ToDo list and look into it a bit more to find a decent solution
sgleadow
2018-05-11 01:26
There isn't a "run tests" script any more, so I think it has to be in the scheme :disappointed:
marko
2018-05-11 01:31
Haven?t tried it yet, but found this -> https://stackoverflow.com/a/41441593/789720
sgleadow
2018-05-11 01:41
Oh wow, I guess you could make something like that work for a pre-action, but not a post-action.
marko
2018-05-11 01:47
Let us know what happens and we?ll make the necessary changes to best support the use case
andrewspinks
2018-05-11 05:39
@sgleadow What are you using to run your tests? Is there a way to start and stop the mock server via the test runner? (e.g. before suite after suite). Ideally we are looking to get rid of the necessity for pre and post scripts entirely, still working out how to do this though...
sgleadow
2018-05-14 03:07
@andrewspinks at the moment, I'm just running them from Xcode, and then on the command line via xcodebuild, so no non-Xcode test runner
This is partly because BuddyBuild isn't as configuration in this regard, it basically takes an Xcode projects and you run schemes.
andrewspinks
2018-05-15 02:46
@sgleadow Can buddy build run arbitrary shell tasks after the tests? Maybe that could push the pact file up to the broker?
sgleadow
2018-05-15 03:34
That's true... we don't actually want the results sent up from anywhere other than CI, so that might work.
marko
2018-05-15 07:46
That?s actually what I use in my currentproject :facepalm:. CI step after the unit tests step runs a script that uploads to the broker.
marko
2018-05-15 07:49
@marko uploaded a file: https://pact-foundation.slack.com/files/U9VQC2742/FAQTE42B1/-.txt
bethskurrie
2018-05-15 08:13
Oh @marko! Don't reinvent the wheel. There is a publish pacts cli already embedded in the swift code.
bethskurrie
2018-05-15 08:15
```
Usage:
pact-broker publish PACT_DIRS_OR_FILES ... -a, --consumer-app-version=CONSUMER_APP_VERSION -b, --broker-base-url=BROKER_BASE_URL
Options:
-a, --consumer-app-version=CONSUMER_APP_VERSION # The consumer application version
-b, --broker-base-url=BROKER_BASE_URL # The base URL of the Pact Broker
-u, [--broker-username=BROKER_USERNAME] # Pact Broker basic auth username
-p, [--broker-password=BROKER_PASSWORD] # Pact Broker basic auth password
-t, [--tag=TAG] # Tag name for consumer version. Can be specified multiple times.
-g, [--tag-with-git-branch], [--no-tag-with-git-branch] # Tag consumer version with the name of the current git branch. Default: false
-v, [--verbose], [--no-verbose] # Verbose output. Default: false
Publish pacts to a Pact Broker.
```
bethskurrie
2018-05-15 08:17
Most of the other languages wrap some native code around this command to make it easier to call from the build framework.
bethskurrie
2018-05-15 08:18
But given a lot of ci runs on Linux, it's pretty easy to call it directly.
marko
2018-05-15 10:35
In the ?swift? code? Knew about ruby standalone, but didn?t want to use it :blush:
bethskurrie
2018-05-15 11:10
The standalone is embedded somewhere in the codebase. I'm afraid you're already using it :-P
marko
2018-05-15 12:27
hmm? poked around a little bit to no avail. Haven?t seen anything like that making `pact-consumer-swift` support swift package manager (ages ago now). I have `pact-mock_service` installed and when I try to run `pact-broker` I get `command not found`. I?ve got mock and stub rubies, but there?s no `pact-broker` in my rubies/bin. Would love an eye opener without the need to install more rubies. @andrewspinks?
andrewspinks
2018-05-15 22:48
It was done before the standalone existed and osx comes with ruby, so it has never been a priority
bethskurrie
2018-05-15 22:49
Very old ruby. Luck I'm forced to support an old version of ruby already for the standalone.
marko
2018-05-15 22:57
Will update READMEs to encourage using the standalone one over using gem as step one
bethskurrie
2018-05-15 23:22
The purpose of the standalone is that you don't need to have ruby installed.
sgleadow
2018-05-21 04:36
For people using pact-ruby-standalone, how to you automatically install it on build machines?
Or CI boxes already use bundler to install gems like `fastlane`, so for the ruby gem approach, I guess that makes sense. For the stand alone runner, what's the preferred approach people are using?
marko
2018-05-21 06:27
I?m currently using http://Bitrise.io and the script step allows me to run bash scripts. Download, copy, run `pact-mock-service`, no issues. Afaik the fastlane ?runs? bitrise
sgleadow
2018-05-21 06:33
I think so. Step 1 is a deep understanding of beer metaphors, step 2 is sending the ruby pull request to brew :laughing:
bethskurrie
2018-05-21 06:34
Ha. Well, according to the rules, they won't accept a PR from the author of the tool, or if the tool can be installed using other version management system.
bethskurrie
2018-05-21 06:35
Maybe we'd get by because the standalone version can't be installed by anything else.
bethskurrie
2018-05-21 06:35
You can make custom taps though, so you can install anything you like however.
sgleadow
2018-05-21 22:25
Do you want it in core homebrew? I can send the PR, but I'd need help creating the recipe.
bethskurrie
2018-05-21 22:26
I can help with the recipe. The underlying logic would be similar to this: https://github.com/pact-foundation/pact-ruby-standalone/blob/master/install.sh
bethskurrie
2018-05-21 22:26
However, we should follow the proper API. I've got some ruby code that does that.
bethskurrie
2018-05-21 22:28
This ruby code downloads the latest release from github using the proper API, however, it uses a gem, which I would expect we can't do https://github.com/pact-foundation/pact-ruby-standalone-windows-test/blob/master/tasks/support.rb
bethskurrie
2018-05-21 22:28
I reckon it's a solved problem though - downloading from github releases must be a common way of installing something using brew.
bethskurrie
2018-05-21 22:33
Hm. It looks like brew hardcodes versions https://github.com/Homebrew/homebrew-core/search?utf8=%E2%9C%93&q=github&type=
bethskurrie
2018-05-21 22:34
So you have to update the formula to allow people to update the version...
sgleadow
2018-05-21 22:36
Yeah I tried to send PRs for new versions for a while, but it's too time consuming
bethskurrie
2018-05-21 22:38
But I guess if people want bleeding edge, they can always use the install.sh script.
sgleadow
2018-05-21 22:39
Yeah, I'm thinking I'd use brew for CI where I just want it to be easy and repeatable.
sgleadow
2018-05-21 22:39
Where does the install script put it? Homebrew wants to put things in a particular place, right? So the installation might need to be slightly different
bethskurrie
2018-05-21 22:41
It's actually easier than that, from my quick browse. Brew has an API for installing from github.
bethskurrie
2018-05-21 22:41
```
class GithubKeygen < Formula
desc "Bootstrap GitHub SSH configuration"
homepage "https://github.com/dolmen/github-keygen"
url "https://github.com/dolmen/github-keygen/archive/v1.304.tar.gz"
sha256 "463b630e395bddad8cc570bd93f5fb42d4d3b6b68de7724cac536381f18b3567"
head "https://github.com/dolmen/github-keygen.git"
bottle :unneeded
def install
bin.install "github-keygen"
end
test do
system "#{bin}/github-keygen"
end
end
```
bethskurrie
2018-05-21 22:44
Oh, sweet. There's even a way to generate the code https://github.com/Homebrew/homebrew-core/blob/d46a3d04dc8b44d9a16fe31bbb7dd2e71e110759/CONTRIBUTING.md#add-a-new-formula-for-foo-version-234-from-url
bethskurrie
2018-05-21 22:44
Sorry, if I'm telling you stuff you already know. I'm just quite impressed.
mat.auburn
2019-01-13 14:01
I wasn?t sure if the specs are backwards compatible and if the swift consumer was going to be upgraded to spec 3
mat.auburn
2019-01-13 14:14
Ahhh Sorry I have just seen the following on http://pact.io
?If you are writing tests on the Consumer side to a different language on the Provider side, you must ensure you use a common Pact Specification between them or you will be unable to validate.?
mat.auburn
2019-01-13 14:15
However I am still curious if there is an effort for teh swift spec to be upgraded to version 3
marko
2019-01-15 23:38
Hi there Matthew, unfortunately I don?t have time to focus on upgrading to spec 3. Maybe @andrewspinks has some time on his hands and have plans to do it?
andrewspinks
2019-01-16 00:35
@mat.auburn The swift library actually runs a ruby mock service underneath. I believe that can generate v3 specs, but will need to double check for you.
bethskurrie
2019-01-16 01:40
If you upgrade to the latest version of the standalone, it will verify the parts of a v3 Pact it can understand, but ignore the new features that were added in v3.
andrewspinks
2019-01-16 01:41
right, but, if I understand correctly, the consumer generated pacts should still be compatible with a pact-jvm regardless.
andrewspinks
2019-01-16 01:44
@bethskurrie for consumers (that aren?t verifying against async messages), is there any advantage to upgrading to v3?
bethskurrie
2019-01-16 01:45
Multiple provider states and provider state params. Actually, that part is supported.
andrewspinks
2019-01-16 01:49
@mat.auburn Unless you want something explicitly available in v3 (https://github.com/pact-foundation/pact-specification/tree/version-3) I think you will be OK.
alan.nichols
2019-11-04 16:50
Hi, hoping someone can help or point me in the right direction! I'm writing tests for iOS that use the ruby server as described in the swift wiki - https://github.com/DiUS/pact-consumer-swift but I am seeing some weird behaviour, and I'm not sure if it's a bug or a config issue. My first test class runs correctly and generates a PACT file as expected. The second test class, for a different API generates a PACT with the new cases as expected, but also includes all of the ones from the first API. Any suggestions?
andrewspinks
2019-11-05 10:15
Hi @alan.nichols. Do you mean that you are testing against two different consumers in the same test suite? I don?t think I?ve ever tried it, so it could be a bug.
alan.nichols
2019-11-05 10:23
@andrewspinks thanks for your reply. My tests are on an iOS app that calls several APIs. I have a test file for the iOS app against API1, and then another test file for the iOS app against API2. For some reason the first contract looks fine, but the second one has the contracts for API1 and API2 squished together in the pact file.
alan.nichols
2019-11-05 10:25
Weirdly, I've duplicated one of the files to see if the effect continues for API3 etc and it hasn't. I'm not sure what the difference between them is but I'll investigate further.
alan.nichols
2019-11-05 11:07
Hi @andrewspinks thanks. I'll look into making a project that I can send over.
I've done some more investigation and have found the following. It seems that the mock service is retaining the contracts generated by each test case, which are then used to generate the contracts as expected. However, this retention of contracts generated from each test case doesn't get reset between different test classes. I assume this is expected behaviour, as the tests to generate contracts for an API could be split over multiple classes?
If so, when creating the json files from the contracts generated by each test case, the provider and consumer that were configured in the test class' setUp() don't seem to be getting used to filter them. Meaning that each json file that is generated contains all of the contracts that have been generated before it, as well as the expected ones.
alan.nichols
2019-11-05 11:08
It's worth noting that the consumer and provider in each contract file is correct, as per the one set up in the test case. But the array of interactions in each case contains all of the interactions that have been generated up to that point.
alan.nichols
2019-11-05 11:13
Some obfuscated contracts as an example where tests for provider1 were run before tests for provider2
shero86
2019-11-06 11:02
hi guys, I?m trying to use `pact-consumer-swift`with Swift 4.2. is there any way I can build? For me it?s only working with swift 5. I tried the previous versions - the same story :disappointed:
kyle.hammond
2019-11-06 15:14
It?s a little hard to tell on GitHub, but I think release v0.5.4 worked with Swift 4.2.
alan.nichols
2019-11-07 13:34
Hi all. In my use case, when initialising MockService, I am using the full constructor as I need to inject a custom PactVerificationService. Currently, there isn't a convenience initialiser for this case, and I need to implement an ErrorReporter in my code to inject.
Does anyone know if there is a reason why there is only the one convenience init? Happy to raise a PR if it just hasn't been added yet.
marko.justinek
2019-11-11 01:03
There was no explicit need until now I suppose. You?re welcome to open a PR.
andrewspinks
2019-11-12 22:25
Thanks @alan.nichols looks good. I?ll try and release a new version in the next few days.
shero86
2019-11-14 15:07
Hi all, quick question. Is pact file generated anyway and not depends on the test result? I was expecting, that contract will not generate, if test are failed, am I wrong? :slightly_smiling_face:
alan.nichols
2019-11-15 09:48
I think it generates always, but you wouldn't publish it if your tests failed.
alan.nichols
2019-11-15 09:51
np! Still learning but that's how it seems. We have tests the generate PACTs running on PRs as blocking until they pass, then on a merge to master it runs those tests again and publishes the contracts.
shero86
2019-11-15 09:59
sounds cool. we?re just trying to make a proof of concept. so I?m just learning how to we can implement pact in our project. thanks for information
andrewspinks
2019-11-17 22:44
Yeah, I?d suggest using this workflow. It could be that a non contract test causes your tests to fail, and you probably don?t want to publish your contract in that situation either (even though all the contract tests passed).
bethskurrie
2019-11-22 03:29
@shero86 only the interactions that were correctly executed get written to the pact file.
bethskurrie
2019-11-22 03:30
But typically the process ends with an error code if there were interactions that did not execute correctly, and hence, you never get to the publish pact step.
bethskurrie
2019-11-22 03:31
Here's some suggestions on how to set up your CI https://github.com/pact-foundation/pact_broker/wiki/Webhooks#consumer-ci
shero86
2019-12-10 12:37
hi guys, quick question , how are you putting requests and response in the tests? are you using structs or just string jsons?
marko.justinek
2019-12-10 21:54
When setting up the test and provider expectations I normally use json strings. When asserting, normally test against expected model objects (ie, immutable structs)
marko.justinek
2020-02-11 00:33
@bethskurrie was a type-o. But somehow Slack doesn?t update the message once the build passes. ¯\_(?)_/¯
marko.justinek
2020-05-08 01:15
I?ve spent a bit of time working on a framework that would run Pact tests without the need to setup the standalone Mock Service.
https://github.com/surpher/PactSwift
Any help poking at it and providing feedback (or even code submissions) will be much appreciated. It is still in _active pre-beta_ development stage and rust lib for in-process testing is also changing as time passes so some implementation choices were made before rust lib expanded.
But I believe it?s useable now as evident in https://github.com/surpher/pact-swift-examples/tree/master/Pact-iOS-Example
kyle.hammond
2020-05-08 17:27
I?m looking forward to Swift 5.3 this summer which supports binary dependencies as XCFrameworks. This might be helpful for PactSwift to get the other required pieces in place with a single package. https://github.com/apple/swift-evolution/blob/master/proposals/0272-swiftpm-binary-dependencies.md
heytaco
2020-08-25 03:57
Hi there! My name is HeyTaco!, and you can use me to give people tacos to show your appreciation. My tacos will spread joy through Slack!
matt.fellows
2020-10-04 23:41
Here is a list of issues tagged `hacktoberfest` for those wanting to ~participate~ pacticipate: https://github.com/search?q=org%3Apact-foundation++label%3Ahacktoberfest&type=Issues&ref=advsearch&l=&l=
marko.justinek
2020-10-09 00:58
Here?s an updated list of issues tagged `hactoberfest` that include issues from `pact-consumer-swift` and `PactSwift`
https://github.com/search?q=org%3Apact-foundation+org%3Asurpher+org%3Adius+label%3Ahacktoberfest+state%3Aopen&type=Issues
marko.justinek
2020-10-29 00:25
Happy to announce https://github.com/surpher/PactSwift (v3 using Rust implementation of PactMockServer) has come quite a long way and should be ready for some proper testing.
I would appreciate anyone taking it for a spin and raise as many issues as possible so we can make it even better faster and reliable in our workflows.
marko.justinek
2020-11-26 22:27
@manali.mogre I assume it is about setting up the test correctly. Combine itself shouldn?t matter. I used pact-consumer-swift with RxSwift tests, and though it was a bit more work to set up properly, it worked just fine.
manali.mogre
2020-11-27 10:27
Thanks @marko.justinek
There was some issue in setting up the tests. Now it works fine.
2020-12-13 23:04
@marko.justinek has a polly for you! Votes in this polly are anonymous :lock:.
chris.r.thomas
2021-02-24 16:56
Hi channel, I?m new to pact testing. I run vapor apps on Linux - I?m about to start looking into using the pact-consumer-swift library but can see it says only macOS etc are supported. Is this a path that if I go down is going to cause me headaches?
marko.justinek
2021-02-24 20:46
Hey. If using libraries gives you headaches you might want to talk to your physician :wink:
But seriously and unfortunately pact-consumer-swift only supports consumer side testing. No provider side testing supported at all. It hasn?t been thoroughly tested on Linux either but the project was set up with SPM in mind. So if consumer side testing is all you?re after then I?d encourage you to try it out and what?s the worst that can happen? Realise it doesn?t work, raise an issue (or many) and we all can get involved to get it working :man-shrugging:
And of course, feel free to clone the repo, make changes and open a PR.
marko.justinek
2021-02-24 20:47
The v3 PactSwift package has the provider side testing on the roadmap far down the line but the time is not permitting me to spend more time at it.
chris.r.thomas
2021-02-24 21:29
We only care about consumer side at the mo - so yep will give it a go and see what happens. Was mostly asking if anyone had already tried and knew it was just a no go from the start.
We?ve got an iOS app and then vapor services that we will use to connect to the providers - so while we could write the contract tests in the iOS app we actually want to be able to have a contract with a provider from our bff and then we own app to bff so don?t need the test there.
I?ll see how I get on - SPM support is absolutely awesome btw!
andrewspinks
2021-02-24 21:31
Yeah, as @marko.justinek said, provider verification isn?t implemented, however, it should be possible to get running using the pact cli, at the end of the day it is just going to hitting your service with http requests. https://hub.docker.com/r/pactfoundation/pact-cli
https://github.com/pact-foundation/pact-provider-verifier/#usage
matt.fellows
2021-03-01 00:38
Seems like this is an appropriate channel for the following conversation: https://pact-foundation.slack.com/archives/C5F4KFKR8/p1614558191081000
chris.r.thomas
2021-03-01 14:29
I?ve been trying to get the pact-consumer-swift package running locally - mainly because I think I need to at least fork it so I can make it run on linux (see above - I want to make it possible to run from a Vapor API to gerenate consumer contracts, all the @objc stuff is gonna cause it trouble) and conform to some of the newer SPM standard (my project freaked out when trying to import the existing one, and tweaking the Package.swift seemed to do the trick)
But I?m having trouble getting tests to pass locally. Everything in PactSwiftSpec and PactSwiftSSLSpec fails - `Could not connect to the server`. I believe i?ve installed everything from brew I need to, i can run things in terminal that start up a pact server, i?ve added the script to the pre and post test (admittedly it still has
```PATH=/path/to/your/standalone/pact/bin:$PATH
pact-mock-service start --pact-specification-version 2.0.0 --log "${SRCROOT}/tmp/pact.log" --pact-dir "${SRCROOT}/tmp/pacts" -p 1234```
so I am def willing to believe that my path isn?t correct and I?ve missed where that should point to?. any help more than welcome :slightly_smiling_face:
marko.justinek
2021-03-01 22:04
Good stuff!
If I remember correctly (it?s been about 3 years) I needed to manually start `pact-mock-service` before running the tests. I tried running on Ubuntu. The pact-ruby-standalone provided through homebrew tap only supports macOS.
Do you have a public fork with GitHub Actions that we can have a peek into?
chris.r.thomas
2021-03-01 22:39
Not yet - I?ll get the Package.swift change up tomorrow for a fork. As I couldn?t get tests running I wasn?t sure if I?d broken something else
marko.justinek
2021-03-01 22:41
I?m going to be offline from tonight until next Tuesday night. I will not be ghosting you on purpose.
marko.justinek
2021-03-01 22:41
But am interested in how to get this running as it will also be beneficial for PactSwift
chris.r.thomas
2021-03-01 22:42
That?s fine - I?ve blanked three days Friday/Monday/Tuesday to have a proper look during work - else I?ll never get time between meetings etc
marko.justinek
2021-03-01 22:43
That?s a good plan when doing research. Having a hypothesis and a couple of questions to answer helps though :thumbsup:
chris.r.thomas
2021-03-01 22:46
Yep, I?m hoping that if I can first get it to run locally (which is macOS) I can be familiar with pact in general - others I work with have used it but in kotlin. Then can focus on CI
Thanks for the heads up
marko.justinek
2021-03-01 22:49
If you installed pact-ruby-standalone via brew, I don?t think you need to update the path in pre- and post-
What macOS and Xcode versions are you using?
We did notice that https://localhost stopped working lately due to URLSessionDelegate not being called and people needed to use https://127.0.0.1 instead to go around that.
marko.justinek
2021-03-01 22:52
maybe try that first, replace any localhost with 127.0.0.1 in your fork?
chris.r.thomas
2021-03-02 08:21
https://github.com/thomas-chris/pact-consumer-swift
This has the package.swift change, and the required folder restructure (nothing major)
chris.r.thomas
2021-03-03 10:19
Still more to fix - some weird SPM thing where the package has to have the same name as the GIT url so I need to change that
tsiakos
2021-03-18 10:08
Hello I was wondering if in pact swift we have something like valueFromProviderState in consumer contract, in order to generate an interaction with a dynamic value based on provider state..
matt.fellows
2021-03-18 10:12
The current one wouldn?t (because it?s based on the Ruby implementation and the v2 spec). @marko.justinek?s v3 one might: https://github.com/surpher/PactSwift
marko.justinek
2021-03-18 20:37
@tsiakos feel free to raise a feature request in the PactSwift repo so we (_I)_ get a clearer idea what you are after and why.
marko.justinek
2021-03-31 21:44
@andrewspinks wanna push the button for the minor version bump release for :point_up: ?
tsiakos
2021-04-08 08:31
Hello, I have a question, I have two different contracts for different providers split in 2 different classes. When I run each test separately each contract file that is generated contains the correct interactions. When I run all the test group together the interaction of the First Test class are also listed in the second contract file as well.. I use explicitly the pact mode overwrite, but I think that this is the default actually with no luck. Any ideas??
marko.justinek
2021-04-08 08:49
Have a look at this https://github.com/DiUS/pact-consumer-swift/issues/98
bethskurrie
2021-04-16 00:19
Mobile devs, I'd love to hear about how you use the Pact Broker (or don't use it) when managing the release process of your mobile app. Do you use can-i-deploy when you deploy to a test device? Do you tag when you deploy? Do you tag when you put the app into the app store? Do you tag when you do the final release to prod? Do you remove tags when a version of the app is no longer supported? Tell me everything!
github
2021-04-19 00:57
GitHub app is successfully upgraded in your workspace :tada:
To receive notifications in your private channels, you need to invite the GitHub app `/invite @GitHub`
marko.justinek
2021-05-12 09:00
Moved to XCFramework.
No more fiddling about with Rust and project file hacking! :tada:
marko.justinek
2021-07-06 05:39
PactSwift got updated/upgraded to v0.5.0 last night. :tada:
https://github.com/surpher/PactSwift
Although still waiting for `aarch64-apple-ios-sim` to https://github.com/rust-lang/compiler-team/issues/428#issuecomment-867685236 so M1 machines can run PactSwift in a simulator. If you don?t mind, drop a https://github.com/rust-lang/compiler-team/issues/428#issuecomment-867685236 there and hopefully it happens sooner :crossed_fingers:
marko.justinek
2021-07-16 00:52
Anyone here with a M1 machine that could validate `PactSwift` now works when running in a Simulator? https://github.com/surpher/PactSwift `v0.5.1` now includes a slice for `arm64-apple-ios-sim` architecture.
marko.justinek
2021-07-16 01:14
All good! Got multiple verifications and `PactSwift` now (from `v0.5.1`) ~works~ _should_ work fine on all macOS machines!
? x86_64-darwin
? arm64-darwin
? x86_64-iOS (simulator)
? arm64-iOS (simulator)
:tada:
marko.justinek
2021-07-16 01:14
can build it for a real device too, but? running a local server on an iPhone? well?
marko.justinek
2021-07-16 01:15
next on the roadmap, supporting provider verification on macOS machines (Vapor) and `PactSwift_linux` ?
marko.justinek
2021-08-02 05:38
https://github.com/surpher/PactSwift `v0.6.1` now supports Linux platforms too (though `libpact_ffi.so` must be provided by the PactSwift user)!
Only consumer side for now but next on the list of features to implement is the provider verification on `macOS` and `linux`.
bryanw
2021-08-13 01:07
Hi all -- on the JVM side, we're using `.pathFromProviderState()` -- is there an equivalent to injected values with pact-swift as per https://docs.pact.io/implementation_guides/jvm/consumer/#having-values-injected-from-provider-state-callbacks
marko.justinek
2021-08-13 01:12
Hey @bryanw, which implementation of swift are you using? `pact-consumer-swift` or `PactSwift` ?
marko.justinek
2021-08-13 01:14
but the answer is no, for both.
I?m working on PactSwift that implements v3, but haven?t added this functionality in. I can add it to the list of feature requests.
marko.justinek
2021-08-15 08:25
@bryanw I?ve added the feature and is available on branch `feature/from-provider-state`
I?d appreciate a sanity check and if it lives up to expectations.
`Matcher.FromProviderState(parameter: String, value: AnyHashable)`
marko.justinek
2021-08-15 13:00
I might update the type for value argument. Keeping it as AnyHashable might cause a few problems.
marko.justinek
2021-08-15 23:32
I?ve updated it and there?s a limit to what types can be used for provider state parameters:
Example usage:
```mockService
.uponReceiving("A request for list of users (using example generators)")
.given(ProviderState(description: "users exists", params: ["page": "3"]))
.withRequest(
method: .GET,
path: "/api/users"
)
.willRespondWith(
status: 200,
headers: ["Content-Type": "application/json"],
body: [
"int-from-provider-state": Matcher.FromProviderState(parameter: "someId", value: .int(100)),
"string-from-provider-state": Matcher.FromProviderState(parameter: "someId", value: .string("some provider generated value")),
"decimal-from-provider-state": Matcher.FromProviderState(parameter: "someId", value: .decimal(Decimal(124.57))),
]
)```
Let me know if it works as expected and I?ll release a `v0.8.0` with this feature :thumbsup:
marko.justinek
2021-08-16 07:02
Should be able to use it in `Request.path` , `headers`, `Request.body` and `Response.body`
dbekman
2021-08-16 18:47
@marko.justinek I've replaced `Regex` matcher with `FromProviderState` and our test that used to fail is now succeeding. :thumbsup::skin-tone-2:
marko.justinek
2021-08-16 22:20
https://github.com/surpher/PactSwift/ `v0.8.0` released and now provides a matcher to match against values injected from provider states.
Can be used in:
? Request path
? Request and response header
? Request and response body
marko.justinek
2021-08-17 01:03
`v0.8.0` is now released!
@dbekman if you haven?t yet, please revert the package version reference.
dbekman
2021-08-19 02:06
@marko.justinek I've ran into a bit of an issue with pact file generated by PactSwift not getting saved. I've traced it down to a function call `*let* port = pactffi_create_mock_server(` line 111 in MockServer.swift. Function returns error code -2 corresponding with `The pact JSON could not be parsed` error. I've looked at pact json and it looks valid. Any ideas?
dbekman
2021-08-19 02:12
There is a corresponding issue. Because result of call to `pactffi_create_mock_server` is not checked for errors all errors get reported as "port not found".
dbekman
2021-08-19 02:39
I've fiddled with some of the values and I found that error was caused by this string: `"[\"entityType\": \"SELLER\", ...]"`. Valid JSON but it blows up parser use by pactffi library.
dbekman
2021-08-19 02:40
Found this comment in serde-json-core:
> //! (\*) Deserialization of strings ignores escaped sequences. Escaped sequences might be supported
> //! in the future using a different Serializer as this operation is not zero copy.
marko.justinek
2021-08-19 03:01
Mind raising the issue at https://github.com/surpher/PactSwift? I?ll have a look. Might ask you for more info/examples. :thumbsup:
Example inputs/setup (remove sensitive data of course) is much appreciated and will help me find a solution.
marko.justinek
2021-08-19 03:04
@dbekman just checking, if you use `#"["entityType":"SELLER", ?]"#` does it blow up too?
marko.justinek
2021-08-19 03:29
There is also a _secret_ env var you can set to log mockserver schenanigans:
`PACT_ENABLE_LOGGING: all` (set it in the scheme > run > arguments. It only takes `all` as the value.
I?m planning to improve that in the future so it?s not _advertised_ as a feature :man-shrugging:
dbekman
2021-08-19 17:30
I've used PACT_ENABLE_LOGGING (you didn't advertise it, but I found it in your source code). That is how I found attempts to connect to port -2:
> *2021-08-19 10:28:32.281202-0700 xctest[196:7607035] PactSwift: Creating MockServer on port 5806:*
> *2021-08-19 10:28:32.281742-0700 xctest[196:7607035] PactSwift: Created a MockServer on port -2 to write a Pact contract file:*
marko.justinek
2021-08-19 21:45
Np. The benefits of being stuck in the 6th Melbourne lockdown :grimacing:
Feel free to report more bugs and/or inconsistencies/suggestions :+1:
dbekman
2021-08-23 20:12
@marko.justinek Found an issue with `OneOf` matcher . `init`s in `OneOf` not marked as `public` and that makes them `internal` by default.
marko.justinek
2021-09-03 00:12
PactSwift `v0.9.0` has been released and now supports _Provider Verification._ Supports the most important options to get the job done (eg: verifying Pacts posted to Pact Broker or Pactflow, verifying pending and WIP pacts, verifying Pacts in a directory, URLs, submitting verification results, etc.).
Supports provider projects (eg. Vapor or Kitura API projects) running on `macOS` and `Linux` .
https://github.com/surpher/PactSwift#provider-verification
dbekman
2021-09-09 01:50
Hit an issue with PactSwift causing random failures in our CI builds. It could be related to this:
> Known Issues
> Using Swift packages with binary targets may result in a ?no such module? error when attempting to import the module of a binary target. (77465707)
marko.justinek
2021-09-09 01:55
It is indeed the case `PactSwift` consumes `PactSwiftMockServer` exposed as a binary `XCFramework` . Otherwise, at least 500MBs of `.a` files would hit your machines and build agents :neutral_face: :exploding_head:
marko.justinek
2021-09-09 02:00
Please keep an eye out for any patterns. I haven?t experienced any intermittent failures like that. Still mostly using 12.5.1, occasionally run on 13.x
dbekman
2021-09-09 02:00
We didn't see this issue initially due to its randomness, but too many people noticed builds braking. Including nightlies.
marko.justinek
2021-09-09 02:01
yeah, that?s not good. I have been pushing new changes out though to PactSwift and its dependencies.
marko.justinek
2021-09-09 02:02
And GH Actions running on macOS 10.x and 11.x, xcode 12.5 for PactSwift itself and its demo projects never seem to have failed like that. Only due to pebkac :man-shrugging:
dbekman
2021-09-09 02:07
Even if one in a hundred builds breaks we are going to see a complain or two a day.
marko.justinek
2021-09-09 02:15
If it?s a SPM issue, there?s little we can do here until they sort it out.
One way to avoid this would be to use forked repos that add up to `PactSwift`, update a few `Package.swift` files to consume the source, not the binary. But that would mean your `PactSwiftMockServer` would need to build the `pactffi` binaries from Rust source code manually.
Unfortunately when building the binary with device and one simulator alone adds up to at least 150MB which doesn?t work well with GitHub?s file size and bandwidth limits. iirc a fatty for device, simulators on x86 and arm64 added up to more than 300MB :exploding_head: . `XCFrameworks` clean out the cruft and that?s pact FFI (`PactSwiftMockServer`) is shared to `PactSwift` as a binary. Probably the cause
A lot of work though and you?d have more processes to maintain yourself. Which again is not something you?d want.
dbekman
2021-09-09 02:18
Will have to talk it over with devops, but they can take a while to do anything.
marko.justinek
2021-09-09 02:20
Sorry to hear it.
Be mindful that building the binaries from rust code takes forever! And even those often fail at Rust compile time. Not even getting to the Swiftland.
Looking at https://github.com/surpher/PactSwiftMockServer/actions most builds for one platform take about 30 minutes on GitHub?s runners.
All of it is OOS and can have a peek here: https://github.com/surpher/PactSwiftMockServer/blob/main/Support/build_rust_dependencies
marko.justinek
2021-09-09 02:22
It?s really only me working on Swift implementation so some aspects of automated scripts might still be quite fragile
marko.justinek
2021-09-09 02:32
Though pactffi doesn?t change much. If it?s a separate build and that drops the binaries somewhere where your Swift build can download and inject, that might be a viable solution. Instead of building from rust code at every Swift CI build? Again, lots and lots of moving parts and even more can go wrong.
I just can?t afford that through GitHub, or AWS, etc? only 2 clones of PactSwift by any CI machine somewhere in the world and _*I?m*_ paying $10 to maintain an OSS project for strangers I never did, never will meet. :disappointed:
dbekman
2021-09-09 03:11
No worries. This is something we'll need to figure out on our end. I was just letting you know about an issue we found.
marko.justinek
2021-09-09 03:19
Thanks, appreciate it. Though if you do figure out what state/situation causes it, please do share. :thumbsup:
marko.justinek
2021-09-10 10:10
Have been thinking about this a bit more. Would it be feasible for you to build a XCFrfamework from PacSwift for your project setup and keep it closer to the codebase or CI? By doing that I believe you?d be able to avoid bringing in a chain of 3 packages where 2nd one in the chain is a binary.
On more than a few bigger projects we?re using this approach and it keeps it stable. No surprise dependency version update so no unexpected breakages.
dbekman
2021-09-10 16:42
One approach to try is to simply add all dependencies to our repo. Would obviously have impact on cloning speed and updating code would be awkward. Waiting for XCode 13 to see if Apple fixed SPM issue is another.
chris.r.thomas
2021-09-23 11:01
https://medium.com/john-lewis-software-engineering/improve-testing-with-pact-contracts-in-swift-db7116c55c37
A colleague of mine worked on using PactSwift recently - or at least started with PactSwift and built something we could use in Vapor (at the time a lot of PactSwift wasn?t working for us in our apis, was more orientated to iOS apps)
We haven?t had permission to open source it or share the code yet (doesn;t mean im not working on figuring out how we can get that permission) but for those interested in the read - please take a look
shout to @marko.justinek who had to help me a while a go going through it all to begin with
matt.fellows
2021-09-23 11:44
Very cool!. The auto matcher feature seems helpful and is a common complaint indeed
matt.fellows
2021-09-23 11:45
I'm not sure about Pact Swift, but in most language if it's just the shape you care about wrapping the whole payload in a `like` matcher is usually sufficient
matt.fellows
2021-09-23 11:46
Also note we are expanding pact at the moment with a plugin framework - so, soon, you'll be able to write your own custom matchers, protocols etc
marko.justinek
2021-09-23 11:58
Great stuff. This is something I was discussing with the current team where we have JSON structures for our offline/dev environment and we would need to duplicate it for Pact tests. Would be great to re-use that existing JSON.
:crossed_fingers:you can get it open sourced, perhaps have it as an introduced extension Pact foundation is working towards supporting.
dbekman
2021-09-24 19:37
Just an update: ended up doing what you suggested. Compiled PactSwift into framework and added it directly to our repo. So far no issues.
marko.justinek
2021-09-25 02:45
Great! Thanks for the update and I?m glad it?s working out for you now.
This way it should also be more stable with version updates not breaking things unexpectedly. Maybe only when you do decide to re-compile into xcframework. It?s ?almost? fine on smaller projects, not on big ones.
marko.justinek
2021-09-28 03:50
When I get some focus time again I?ll implement something in `PactSwift` to create JSON `Data` from the fixture containing matchers, etc. It should be easy since parsing of `body` is already done. Only need to expose it as a simple interface.
It?s the other way around from what John Lewis? did. But it can remove the duplication of fixtures for pact tests and ones to use in offline/dev environments.
dbekman
2021-11-22 22:24
There it is:
> Resolved in Xcode 13.2 Beta 2:
> Resolved an issue where Swift packages with binary targets sometimes failed with a ?no such module? error when attempting to import the module of a binary target. (77465707)
dbekman
2021-11-22 22:36
Nope. Just saw release notes for beta 2 and there it was. :slightly_smiling_face:
marko.justinek
2021-11-22 22:38
No worries. I honestly haven?t hit this issue on my projects. I really only use GitHub Actions and Buildkite with my own Mac Mini agent.
Someone also raised this as an https://github.com/surpher/PactSwift/issues/83. Watch that space if they provide some feedback.
dbekman
2021-11-22 22:45
Yeah local builds pretty much always work. Once 3.2 is adopted for our CI builds I'll give it another go, but it is probably gonna be some times next year.
mesut.gunes
2022-01-31 20:52
Hey, I am having problem with creating correct matcher. Whatever I tried I could not create the following
```{
"status": "fail",
"data": {
"promotion_code": [
"Not Found"
]
}
}```
This worked for creating contract but it doesnt create the correct one
```Matcher.eachLike([
"status": "fail",
"data": Matcher.eachLike([
"promotion_code":
"Not Found"
])
])```
the output is this
```[
"status": "fail",
{
"data": [
{
"promotion_code": "Not Found"
}
]
}
]```
thank you :grinning:
mesut.gunes
2022-01-31 21:03
I am using this implementation: https://github.com/DiUS/pact-consumer-swift#matching
matt.fellows
2022-01-31 21:22
Don?t you want something like this:
```{
"status": "fail",
"data": {
"promotion_code": Matcher.eachLike("Not Found")
}
}```
It?s just the `promotion_code` that should be an array. Whevere you specify `eachLike` the attribute it?s associated with becomes the array
marko.justinek
2022-01-31 21:50
you will need to use the DSL for your expected JSON:
```let expectedResult = [
"status": Matcher.term("fail|success", "fail"),
"data": [
"promotional_code": Matcher.eachLike("Not Found")
]
]```
mesut.gunes
2022-01-31 21:57
I think the problem is eachLike it is accepting array `[()]` but it doesnt create `{}`
marko.justinek
2022-01-31 21:58
I just updated the example as I figured out what I needed to look at :slightly_smiling_face:
marko.justinek
2022-01-31 21:59
`Matcher.eachLike()` will create an array of types you pass it in. If you pass it in a dictionary, it should create an array of objects
marko.justinek
2022-02-01 04:00
@mesut.gunes have you managed to set up your expected result to work for your case?
mesut.gunes
2022-02-01 08:57
@marcbetts above solution solved the easy one thanks for it, I am trying to fix the complex one
ardiel.fuentes
2022-02-09 07:29
Hello, I'm the backend colleague :slightly_smiling_face:.
As you answered to this issue, on backend and Android side we are using v3 spec, We are studiying migrating the apple lib to the new one that supports v3, but what we didn`t locate in its documentation is if we could use expressions like the noted in the issue.
```"today +1 day @ 6 o'clock pm"```
If it is possible to use this kind of expression, could you, please, give us some examples of its usage?
Thanks a lot!
matt.fellows
2022-02-11 02:23
If you?re wanting to put that expression into the _pact_ file, I don?t know if that is possible.
@uglyog I don?t believe that?s possible in Pact JVM. Can you do that?
marko.justinek
2022-02-13 03:27
No. I just tried this out and `PactSwift` passes the `expression` into the DateTime example generator. But `pact-rust` only spits out the `type` and `format` - just like the spec v3 says.
The way I can see this making sense is to have the ?expression? (or really just a provided `Date` object) used for the consumer tests. But goes against best practices where Pact would be used to test values instead of validating structure and types.
marko.justinek
2022-02-13 03:29
There?s a branch now that exposes a `ExampleGenerator.DateTime(date: Date, format: String)`that will use the provided date converted to `String` using the provided format for the consumer test. Instead of the existing `ExampleGenerator.RandomDateTime(format: String)` that returns a formatted date for consumer tests.
But I don?t think there?s a declarative way of defining `Date` objects though in Swift where you could just say ?some day in the future added by 3 hours and 4 milliseconds?. You?ll need to use `Calendar` and create the `Date` object by adding date components.
marko.justinek
2022-02-13 03:37
I?d be very confused if I saw a:
```{
"startDate": "some words describing a date" // instead of exemplary "2023-02-13"
}```
so then I can?t use `Decodable` on to convert into `Date` object? :sweat_smile:
marko.justinek
2022-02-14 22:52
Tracking this feature request in pact rust-core at https://github.com/pact-foundation/pact-reference/issues/180
ipoe
2022-02-21 15:04
Hi all,
I want to integrate https://github.com/surpher/PactSwift to our iOS application that works with the backend via GraphQL and I'm struggling finding a way to make it work.
Does PactSwift has a helper method for working with GraphQL as *pact-js* ?
ipoe
2022-02-21 15:05
I'm getting the following error and I'm not sure if it is because of GraphQL or maybe my approach is not good.
```Failed to verify Pact! Actual request does not match expected interactions...
Reason:
Missing request
Expected:
POST /graphql```
matt.fellows
2022-02-21 20:55
That error is pretty clear tho - you're not sending a POST request to /graphql
ipoe
2022-02-23 16:22
Hi @matt.fellows @marko.justinek,
I tried to insert de graphql specific data in to the body, but I'm still getting the same error as above, not sure if I'm missing something, if you can please assist or point me to what I'm doing wrong. This are some screenshots with what I'm doing on my side:
ipoe
2022-02-23 16:24
Am I missing some configurations some where?
I added the PactSwift package to my test target and wrote the above simple test with an endpoint that gets the minimum app required version.
ipoe
2022-02-23 16:27
Maybe my approach for trying to make it work with graphql is wrong, does that graphql wrapper planned to happen for the near future?
marko.justinek
2022-02-23 20:56
PactSwift does not (yet) support GraphQL. I?ll get the support going for it soon. Just can?t promise any dates.
marko.justinek
2022-02-23 20:59
Also, PactSwift mock server runs on a localhost on a randomly assigned port. I see you are assigning url to your client. If your client is sending it to the real server your test will fail due to localhost not being hit.
Use the mockServiceURL passed into the .run methods completion block.
ipoe
2022-02-24 18:50
Thank you for pointing me in to the right direction, but I managed to stumble upon another issue:
ipoe
2022-02-24 18:51
I'm getting this error and don't know how to go around it. If I try to send nil or NSNull it will throw me this "*failed - Error preparing pact! A key or value in the structure does not conform to 'Encodable'*"
ipoe
2022-02-24 18:57
I also tried to remove the "variables" key and value pair but I'm getting this error. Maybe I can try to remove the variables from the graphql query, from Apollo, not sure if that is possible,
marko.justinek
2022-02-24 23:39
PactSwift only accepts types that conform to `Codable`. As it iterates through the content, extracts any `Matcher` and `ExampleGenerators` you send it and erases them into a custom `AnyEncodable` type so that it can be sent across http and the payload is prepared for `PactSwiftMockServer` to consume and be able to interact with.
When you serialised your json body into your `jsonData` you sent something that doesn't conform to `Encodable` - validate jsonData does not include something weird.
marko.justinek
2022-02-24 23:41
for the `"null"` , it should've been fine in your regular REST interactions as it's defined as a `String`. If you'd need to define a `"nullable_value": null` you'd need to use a `Matcher.MatchNull` - again due to conforming to `Codable` protocol.
marko.justinek
2022-02-24 23:50
though I am confused about
```Expected 'null' to be equal to 'null' - Body does not match the expected body definition```
This message is coming from the pact rust core.
There is also a way to log interactions between PactSwift and Pact rust-core by setting an env var in your scheme:
`PACT_ENABLE_LOGGING: all`
marko.justinek
2022-02-24 23:54
the
`Expected a Map with keys id, operationName, query but received one with keys id, operationName, query, variables - Body does not match the expected body definition.`
is pretty much a valid test and it is failing (because it seems to be too strict). You are defining the expectation that your client will send a specific object with 3 keys, but your client is actually sending an object with 4 keys. So that means your client is not honouring the contract and doing something different to the set expectations.
ipoe
2022-02-25 14:49
Hi again, I think I managed to make it work, but I'm having an issue with the dynamic port, can I make it static? Because when I start my services locally they go on to static port number.
ipoe
2022-02-25 15:03
Or, maybe I understood it wrong. Should that endpoint that I am running end up heating my local service and respond successfully?
ipoe
2022-02-25 15:18
But in this case you don't need to have your API services running locally, I understood it wrong.
ipoe
2022-02-25 16:38
Also, if I want to create multiple tests, do I need to create multiple test classes with diferent consumer and provider names? Because, currently I see that it overwrites the last one in the `tmp/Pact` folder.
marko.justinek
2022-02-25 22:09
Awesome!
Port for mock server is randomised for each test that?s run. The mock server stands in for your "real" API services (local or remote) if that?s what you?re saying/asking? Pact?s mock server is used as it has the logic to verify incoming interactions for client tests and responds with mocks. It takes your expectations, listens to the requests, responds with what you defined in your test and keeps a tally on what the interactions were and if they match.
You should have a static MockService object to be able to append multiple tests on one provider (to one contract file). Otherwise it will only write the last interaction into pact file. See the examples provided on PactSwift?s github repo.
Feel free to suggest any improvements for GraphQL specifics by sharing info here or raise an issue in the repo :+1:
marko.justinek
2022-03-05 22:11
@marcelino.garcia @ardiel.fuentes PactSwift should be supporting the datetime expressions now on branch `feature/generator/datetime-expression` (link: https://github.com/surpher/PactSwift/tree/feature/generator/datetime-expression)
Have it a spin and let me know if it works as expected. If it does I?ll release a new version.
marko.justinek
2022-03-05 22:13
Example usage:
```.willRespondWith(
status: 201,
body: [
"start": ExampleGenerator.DateTimeExpression(expression: "@ next hour", format: dateFormat)
]
)```
marko.justinek
2022-03-05 22:47
marko.justinek
2022-03-08 02:00
@marcelino.garcia if you don?t mind leave a comment on the PR for this if it fits the requirements. PR: https://github.com/surpher/PactSwift/pull/84
I?ll then prepare a new version to release.
marko.justinek
2022-03-10 12:45
No worries. Thanks for your PR. I completely missed that rather obvious one :man-shrugging:
lramos
2022-03-17 20:25
Hello there, folks. I'm new to PACT testing and I wanted to write a test to assert the type of data in a dictionary. For example,
```/endpoint1/dictionary returns
{
"abc": { "field1": "value1", "field2": 123 },
"xyz": { "field1": "value2", "field2": 456 }
}```
I know asserting the format/type of the data is possible when the response is an array (using `eachLike`), but currently there doesn't seem to be a way to iterate over the "values" of a dictionary without knowing the exact keys in advance. Is that correct or am I missing something? At least `eachLike` doesn't seem to work in that scenario. Does anyone know if that is possible?
matt.fellows
2022-03-17 20:49
The like matcher is for this purpose: https://github.com/pact-foundation/pact-python#likematcher
lramos
2022-03-17 21:11
Thank you Matt! At least the contract generation step runs with like/somethingLike. Thank you that gives me something I can work with.
lramos
2022-03-17 21:48
Oh it looks like Pact is unable to apply the rules correctly though. In my example above, if we use `like` (`somethingLike` in SwiftPact)
1. Pact will try to match it as an object
```Matchers.somethingLike([
"field1": Matchers.somethingLike("aaa"),
"field2": Matchers.somethingLike(111)
])```
Error: wanted key "field1" but found key "abc"
2. If I try to match like this, Pact will try to match it as an array
```Matchers.somethingLike([
[
"field1": Matchers.somethingLike("aaa"),
"field2": Matchers.somethingLike(111)
]
])```
Error: type mismatch - wanted List but got dictionary
matt.fellows
2022-03-17 21:58
Something wrong with my brain today, I swear I was in the python channel!
matt.fellows
2022-03-17 21:59
I?m guessing you?re not accounting for the top level `abc` and `xyz` keys
lramos
2022-03-17 22:02
No worries and thank you for jumping in! My question is given my example of service response, is there a way to assert the types of the items in the dictionary without knowing the dictionary keys?
```/endpoint1/dictionary returns
{
"abc": { "field1": "value1", "field2": 123 },
"xyz": { "field1": "value2", "field2": 456 }
}```
In my case, "abc" and "xyz" would be the keys. If I don't know them, is it possible to iterate on the "values" of the dictionary while ignoring the keys?
The reason is in my use case, keys can be added or removed at will, but I want to assert that, whenever present, the items in the dictionary have the fields I need.
matt.fellows
2022-03-17 22:03
there is a matcher called eachKeyLike available in the latest pact, but not sure if Swift has supported that
matt.fellows
2022-03-17 22:03
I don?t know the swift interface well enough, so check the docs (or source code)
lramos
2022-03-17 22:04
Oh ok. Yeah I think that's not yet in SwiftPact. I'll keep an eye out for `eachKeyLike` if it's added in future releases. That's good info
matt.fellows
2022-03-17 22:09
swift should be able to support it, because it?s on the latest core, so it?s probably not a lot of work if you?re up for creating a PR
marko.justinek
2022-03-17 22:52
Indeed it?s on the latest core (a week ago).
It should be very easy to create a new matcher. Hopefully docs are clear.
Guidelines on how to contribute:
https://github.com/surpher/PactSwift/blob/main/CONTRIBUTING.md
Base `Matcher` (and look at implementation of some of the existing ones for inspiration. Don?t forget about the tests!):
https://github.com/surpher/PactSwift/blob/main/Sources/Matchers/Matcher.swift
The nastiest of things (due to a Swift bug and still wanting to support macOS 10.x) is you have to specifically handle the matcher in `PactBuilder.swift`:
https://github.com/surpher/PactSwift/blob/main/Sources/PactBuilder.swift#L95
marko.justinek
2022-03-17 22:54
If headspace doesn?t allow it (I totally get it!). I might be able look into it in the next couple of days.
lramos
2022-03-22 20:31
Hi @marko.justinek I wanted to file a ticket to better define the problem we've been discussing in this thread. Does this story description makes sense to you ?
marko.justinek
2022-04-03 23:44
lramos
2022-04-05 15:19
Looks really good Marko! thanks for the extra research on the matching rules. That's one spot where I was clueless.
marko.justinek
2022-04-05 21:43
Run a spike with your provider to validate it really works. I written a couple of tests but I?m tight on time. If it?s good I?ll release a new version.
mira.kim
2022-04-12 00:55
:wave: Hello, team.
I?m doing some tech investigation to see how we can integrate Pact to our iOS app. I was looking at https://github.com/surpher/PactSwift and it doesn?t seem to support Cocoapod, only carthage and SPM. Is there any plan to add Cocoapod support in the future? I saw that there is https://github.com/DiUS/pact-consumer-swift which supports cocoapods but I?m not sure what?s the long term support plan for that version.
I?d appreciate some info to help us make the right decisions, thanks!
marko.justinek
2022-04-12 02:01
There is no plan to share PactSwift through Cocoapods.
pact-consumer-swift is slowly sunsetting.
marko.justinek
2022-04-12 02:13
Best suggestion I have if you don?t want to introduce another dependency manager is to clone `PactSwift` , generate `PactSwift.xcframework` , add it to your project and link it to the correct target.
mira.kim
2022-04-12 02:16
I see, thanks for the info. I?m not a fan of cocoapods but it would be a significant effort to move away from that and I think it might be quite complex to use both SPM and cocoapods together. That could be an option I guess? :woman-shrugging:
marko.justinek
2022-04-12 02:19
Adding SPM packages to your project(s) shouldn?t be a problem at all.
pact-consumer-swift is probably going to stick around for a while as is. It?s just that provider frameworks (go, js, jvm?) are pretty much all moving to support Pact spec v3 and you?d be left behind without all the bells and whistles that v3 provides.
lramos
2022-04-12 16:58
Sorry for the delay Marko, I got sidetracked because I moved to a different project. I'll try to make time to validate it soon. :pray:
sstenhouse
2022-04-12 20:15
Afternoon all!
I am currently working on getting PactSwift implemented with my team, so I may have a few questions for you. We recently switched to using M1 Macbooks on Xcode 13.1 (running with Rosetta). When I try to run a Pact consumer test I am getting a few errors, most notable being this error:
`mach-o file, but is an incompatible architecture (have 'arm64', need 'x86_64'`
Our Carthage file is set up as outlined here: https://github.com/surpher/PactSwift/blob/main/Scripts/carthage
Are there any known issues with PactSwift on Xcode 13.1 + M1 Macs? Or if you know a solution to this error, that would really help me out. Thank you!
marko.justinek
2022-04-13 00:31
On arm64 machines, regardless if you run Xcode using rosetta, you should use vanilla `carthage` to build your dependencies:
`carthage update --no-use-binaries --use-xcframeworks`
bkapadia
2022-04-20 22:00
Hi pact team, Im trying to run PactSwift on my machine but im getting an error when i try to run `Could not find module 'PactSwift' for target 'x86_64-apple-ios-simulator'; found: arm64, arm64-apple-ios, at: / path of pactswift module` ?also, when im not getting this error the pact test runs but console output mentions that PactSwiftMockServer could not be found? Im using cartfile `github "surpher/PactSwift" ~> 0.12`
marko.justinek
2022-04-20 22:05
What?s your machine architecture and how are you creating your `PactSwift` dependency through `carthage` command?
I?m suspecting you?re not using `--use-xcframeworks` ?
bkapadia
2022-04-21 17:08
and im using this command `carthage update PactSwift --no-use-binaries --use-ssh --use-xcframeworks`
marko.justinek
2022-04-21 21:41
You are using the provided script for Intel machines, right?
https://github.com/surpher/PactSwift/blob/main/Scripts/carthage
bkapadia
2022-04-22 16:00
thanks for quick response Marko. I was able to update the carthage script so im no longer getting the build issue but the when the test runs i see the following error for ?no such file? for PactSwiftMockServer *`Library not loaded: @rpath/PactSwiftMockServer.framework/PactSwiftMockServer` although when* running carthage i do see that the package is resolved:
``` PactSwiftMockServer: https://github.com/surpher/PactSwiftMockServer.git @ 0.3.5```
marko.justinek
2022-04-22 20:32
Not quite sure what?s happening there? Have never hit such a problem on Intel nor Silicon machines.
Perhaps remove any PactSwift xcframework remnants from `../Carthage/Build` and `../Carthage/Build/iOS` and try using the script again?
marko.justinek
2022-04-27 04:17
Any progress verifying the `EachKeyLike` matcher implementation @lramos?
marko.justinek
2022-04-27 22:38
Had another case of this. There might be a potential issue within `carthage` for this where it?s failing to copy transient binaries (which `PactSwiftMockServer` is). It seems it started occurring with Xcode 13.2 (or maybe 13.1?). I can not reproduce this using an Intel machine running Xcode 13.0. There is an open issue on carthage github project indicating binaries are not copied. `PactSwiftMockServer` is a binary package (xcframework) being vended to `PactSwift` project through SPM. Perhaps that?s where things go astray? Looking at carthage logs there doesn?t seem to be anything wrong.
marko.justinek
2022-04-28 02:45
I?ve raised an issue with Carthage although I?m not entirely convinced this is carthage problem but Xcode 13.2+.
https://github.com/Carthage/Carthage/issues/3270
mira.kim
2022-04-29 04:22
Hi team,
I?m trying to write some pact test in Swift and I can?t find where the pact file is generated.
I can see the test has failed (which I expected) but I expected to see some pact json file somewhere.
```failed - Failed to verify Pact! Actual request does not match expected interactions...
Reason:
Missing request
Expected:
GET /products```
mira.kim
2022-04-29 04:23
I tried setting the PACT_OUTPUT_DIR without much success (not sure where I?m setting it and what I?m supposed to set it to)
and also tried setting it in the property of MockService without much success either.
mira.kim
2022-04-29 04:24
I also see this popup continuously every time I run the test despite me clicking the Allow every time. It makes me think something is not setup properly.
mira.kim
2022-04-29 04:25
so? how do I make the test pass? is it related to the network connection prompt?
mira.kim
2022-04-29 04:27
maybe I?m not understanding this correctly. Is the error message telling me the request is not being sent at all?
matt.fellows
2022-04-29 04:31
The error message says that you expected your app to make a `GET` request to `/products` on the pact mock server, but it did not receive one
matt.fellows
2022-04-29 04:31
that means your client code is not pointed at the mock server and sending the request in your unit test
mira.kim
2022-04-29 07:09
Gah I found the problem. I wasn?t using the url from the mock service correctly. :zipper_mouth_face:
sstenhouse
2022-05-09 13:20
I'm running into the same issue while writing my pact test. Just curious how you went about resolving this issue?
marko.justinek
2022-05-10 06:35
Did your pact test suite finish successfully? @sstenhouse if the test run fails then the file is not (over)written.
The default for iOS projects is
`/tmp/pacts`
If you set up a `PACT_OUTPUT_DIR` environment variable (in Run > Arguments tab of your scheme) then it should be written in that folder. I normally set it to `$(PROJECT_DIR)/tmp/pacts`
If testing a macOS project, then pact files are written into `Documents` folder of your app's sandbox.
If testing a non-Xcode project (Linux), set the env var `PACT_OUTPUT_DIR` to where you want the file to be written.
https://github.com/surpher/PactSwiftToolbox/blob/main/Sources/PactSwiftToolbox/PactFileManager.swift
marko.justinek
2022-05-10 06:46
There is also a convenience `init` on `MockService` class that allows you to pass in a `URL` of your directory. Have you tried that?
https://github.com/surpher/PactSwift/blob/6c9c3a1b9142e353781e5f589bcb9db8895ca38d/Sources/MockService.swift#L62
sstenhouse
2022-05-10 20:56
@marko.justinek It has never passed successfully, I keep getting this error:
```failed - Failed to verify Pact! Actual request does not match expected interactions...
Reason:
Missing request
Expected:
GET /products```
When I run the test, I see that the base url has been replaced by the mock server url so I'm not sure why it wouldn't be communicating with the pact server.
marko.justinek
2022-05-11 02:57
Is your API client implementation triggering the request? Can you verify/debug it?
j.shankarnath
2022-05-13 07:53
Hi Team,
I am working on writing consumer contract test using PactSwift but In our company we are using cocoapods as dependency manager.
I created xcFraework using Fastlane(fastlane run create_xcframework scheme:"PactSwift-iOS" xcframework_output_directory:"/Users/shankarnathreddy/projects/PactSwift" product_name:"PactSwift?) and Pod spec but I have below problems.
*Expected Result :* I should be able to write consumer contract test.
*Actual Result :*
1.PactSwift module itself is not coming to import in the test class after referencing this in our customer IOS APP project. (*Error : No such module 'PactSwift')*
2.I created separate test IOS project, manually added xcFraework to this project(without POD) and here I am able to import PactSwift module but getting error as *"Failed to build module 'PactSwift' for importation due to the errors above; the textual interface may be broken by project issues or a compiler bug?.*
*Environment* : MacBook with Intel i9 and Xcode 13.2.1
Could you please help me here ? let me know if any further info is required.
marko.justinek
2022-05-13 08:00
https://github.com/Carthage/Carthage/issues/3270
Apple seems to have changed how they link transient binary dependencies at around Xcode 13.2.
There has also just now been a change pushed to `main` (less than an hour ago). Perhaps try building your XCFramework with latest changes on `main` . Might started working. I've ran that and I haven't seen the same errors anymore.
Carthage is still acting up.
marko.justinek
2022-05-13 08:43
There still might be some hiccups though as I was just looking into this this arvo but haven?t pinpointed the exact issue yet.
Using SPM is the only way I?ve been 100% without issues.
j.shankarnath
2022-05-13 09:52
ok, I created xcframework with latest changes and it resolved problem2(referencing xcframework directly) but still problem1 is exists with cocoapods.
j.shankarnath
2022-05-13 09:53
if i switch to latest version of xcode i.e 13.3, will this issue get resolved ?
marko.justinek
2022-05-13 12:24
Not sure about cocoapods. Am not using it (hate it wholeheartedly :man-shrugging: so any help from anyone is much appreciated) and PactSwift was never considered to be used through cocoapods.
Actually SPM is going to be the only sure way for the future.
Regarding a framework not being able to be imported I?ve experienced it?s a cache problem. Clearing the build folder ?mostly? fixes the problem if the frameworks are built and linked properly.
j.shankarnath
2022-05-13 15:59
Now its working fine with xcode 13.2.1 only, pod target issue was there and now it got resolved.
diede
2022-06-02 10:14
Hi, my team wants to use pact in or microservice deployment. We have a few vapor/swift services. And I was tasked to research if we can use pact. And I am struggling a bit :see_no_evil:. The pact files do not seem to appear on my machine. This is the code, I am using an async function, which is the only difference I can see from the examples. I tried to change the directory to one that does not exist and then I get an error that it could not write the file. But when I create that directory it is silence again and my test succeeds. Thank you very much in advanced :pray:.
``` var mockService: MockService!
var app: Application!
override func setUp() async throws {
mockService = MockService(consumer: "payments", provider: "coexp")
app = Application(.testing)
}
func test_create_session() {
mockService
.uponReceiving("Create a card session request")
.withRequest(method: .POST, path: "/session")
.willRespondWith(status: 200, headers: nil, body: [
"session_key": ExampleGenerator.RandomUUID(),
"terminal_id": ExampleGenerator.RandomUUID(),
])
mockService.run(timeout: 5000) { baseURL, done in
let terminal = TerminalService.live(baseUrl: baseURL)
Task {
let result = try await terminal.getSessionKey(self.app.http.client.shared)
switch result {
case .success(_) :
XCTPass()
case .failure(_):
XCTFail()
}
done()
}
}
}```
diede
2022-06-02 10:44
this one and then looked at this: https://github.com/surpher/PactSwift#example-consumer-tests
marko.justinek
2022-06-02 10:53
And have you tried passing the directory URL to the MockService initialiser?
diede
2022-06-02 11:16
Yes, I did but must have made a typo or something. Now it works. wonderful thank you for the help :slightly_smiling_face:
marcello.rigan335
2022-06-02 13:40
Hello, i got a question for you. When using EachLike do i have to add the min value of the length of the array like in js? And is the default 1 if not provided?
oherescu
2022-06-27 19:40
Hi there! Quick question regarding the
> *Reason:*
> *Missing request*
error
I understand that this error can be triggered by not pointing the api client to the mock pact server. Is it possible that the server itself is not up and running? We're checking the request and it seems to be pointing to localhost, therefore presumably to the pact server.
> ```class PactExampleTest: XCTestCase {
> static var mockService = MockService(consumer: "Our-app",
> provider: "Our-orders-service",
> writePactTo: URL(fileURLWithPath: "/dev/pacts/folder", isDirectory: true))
>
> func testGetUsers() {
> PactExampleTest
> .mockService
> .uponReceiving("A request for orders")
> .given(ProviderState(description: "orders exist", params: ["id": "12345"]))
> .withRequest(method: .GET, path: "/v1/orders")
> .willRespondWith(
> status: 200,
> headers: nil,
> body: ["test": "test"]
> )
>
> let apiClient = CloudApi()
> let accessTokenProvider = MockAccessTokenProviderType()
> apiClient.authenticatedHTTPService = AuthenticatedHTTPService(accessTokenProvider: accessTokenProvider)
>
> PactExampleTest.mockService.run(timeout: 1000) { [unowned self] mockServiceURL, done in
>
> //this makes sure that the apiClient will hit the correct base url (127.0.0.1:<portNumber>) that's provided by mockServiceURL
> let cloudEnvironment = mockCloudEnvironment(onlineOrderingURL: mockServiceURL)
> let cloudEnvironmentLoader = CloudEnvironmentLoader()
> cloudEnvironmentLoader.saveCurrentEnv(cloudEnvironment)
>
> apiClient.retrieveOnlineOrders(forID: "1234") { dict, error in
> print("DICT: \(dict)")
> print(error)
> }
>
> done()
> }
> }
> }```
oherescu
2022-06-27 19:55
Further question: what does the `ProviderState` describe? If we pass
> ```ProviderState(description: "orders exist", params: ["id": "12345"])```
what is that supposed to match up with? Does that mean the API is expecting a body with `id` value of "12345"? In the example params are sent to ProviderState for a .GET request, so presumably these are not parameters passed along with a request. Are we just completely off in our assumptions?
Thanks in advance :slightly_smiling_face:
marko.justinek
2022-06-27 21:21
These help provider side set up the state of their side of the test. They are not parameters of a request. Think of ?provider state? as a state of environment/data at the time of the request.
https://github.com/pact-foundation/pact-specification/tree/version-3#allow-multiple-provider-states-with-parameters
marko.justinek
2022-06-27 21:31
In your particular case the provider would seed their database with an order with id:1234.
marko.justinek
2022-06-27 21:35
Is the request actually triggering? And is the path of the request /v1/orders? If the path is ?close enough? mock server will return a missing request but also provide a close match it got. If it fails with missing request it is usually the case of request not hitting the mock server at all.
marko.justinek
2022-06-27 21:37
Reading this on my mobile so its a bit hard to see? but is done() called before dictionary in response is received by your apiClient?
pollet_22
2022-08-14 12:48
Can any one recommend a tutorial or documents which helps me in starting contract testing between app and API gateway
marko.justinek
2022-08-16 00:24
This one seems pretty good. https://joostoostdijk.com/posts/creating-a-pact-with-swift
It uses the https://github.com/DiUS/pact-consumer-swift framework. But the workflow applies for https://github.com/surpher/PactSwift as well.
Here?s another one that seems to cover quite a bit. https://medium.com/@rajatvig/ios-docker-and-consumer-driven-contract-testing-with-pact-d99b6bf4b09e
But there?s no ?official? one for Pact for Swift. I have it on my to-do list but I?m currently professionally focusing on things way too far away from Pact, unfortunately.
gunesmes
2022-09-01 15:42
Hey, glad to see some pact experts here.
I have question related to mobile app contract testing. Let?s say we have microservices behind a API Gateway. I want use pact-swift for iOS project and then it is sure that iOS project will be the consumer. It calls may endpoint via the API Gateway so who should be the providers? API Gateway is kind a proxy to distribute the requests. If the microservices are the provider, I should have multiple providers I think this is ok. However there might be some cases which some checks will redundant because they were checked between consumer-provider relations by microservices.
What is the general approach for this?
thanks in advance
gunesmes
2022-09-01 15:47
@marko.justinek in this example, API is the the provider but the API gateway just distributes the requests to the microservices, it is more on configuration tooling not unit testing.
matt.fellows
2022-09-02 00:03
This doc is a bit of a draft, but expresses some of the ideas/challenges with gateways.
https://docs.pact.io/recipes/apigateway
matt.fellows
2022-09-02 00:04
You definitely want a contract from the real consumer (i.e. the mobile app), because if the microservices change, then they could break you
