How to use an json config file with dart defines to run the patrol test?

[anfernandezz]

Hello! I had this issue when running integration tests but I solved it by defining the --dart-define-from-file, which is used in our launch.json. So basically, the code I'm working on uses --dart-define-from-file for each environment config to run.

When I run the command patrol test --target integration_test/login_test.dart --verbose I get this error:

Looking for GoogleService-Info.plist in /Users/MyName/workspace/ProjectName/ProjectName/ios/config//GoogleService-Info.plist

Between the config//GoogleService-Info.plist there it should be 'dev', which we get from an environment string.
I have tried:

• Adding all the contents from the config dev.json file into a .patrol.env as keys
• Passing the keys individually in the command

With no luck, in the logs I get that it reads the dart-defines I have passed, but it still doesn't retrieve it when looking for the GoogleService-Info.plist.

I think it would be a good idea to add the --dart-define-from-file to facilitate this, but shouldn't also adding all the keys into the .patrol.env have the same effect?

I appreciate all the help you can provide, thanks!

[bartekpacia]

Hi Ana,

Could you please share the full output of running the patrol command and embed it in a spoiler? Like this:

Details

$ patrol test --target integration_test/login_test.dart --verbose
You're using Patrol CLI 2.0, which has breaking changes.
Read the migration guide at https://patrol.leancode.co/v2.
Disable this warning by setting the PATROL_MIGRATED environment variable.

Verbose mode enabled. More logs will be printed.
Error: target file integration_test/login_test.dart does not exist
#0      throwToolExit (package:patrol_cli/src/base/exceptions.dart:7:3)
#1      TestFinder.findTests (package:patrol_cli/src/test_finder.dart:41:11)
#2      TestCommand.run (package:patrol_cli/src/commands/test.dart:104:23)
#3      CommandRunner.runCommand (package:args/command_runner.dart:212:27)
#4      CompletionCommandRunner.runCommand (package:cli_completion/src/command_runner/completion_command_runner.dart:81:18)
#5      PatrolCommandRunner.runCommand (package:patrol_cli/src/runner/patrol_command_runner.dart:314:30)
<asynchronous suspension>
#6      PatrolCommandRunner.run (package:patrol_cli/src/runner/patrol_command_runner.dart:258:18)
<asynchronous suspension>
#7      patrolCommandRunner (package:patrol_cli/src/runner/patrol_command_runner.dart:73:20)
<asynchronous suspension>
#8      main (file:///Users/bartek/.pub-cache/hosted/pub.dev/patrol_cli-2.0.0/bin/main.dart:6:20)
<asynchronous suspension>

I understand that your app has a few flavors, and for each flavor, you have a separate GoogleService-Info.plist, right? Doesn't specifying the dev flavor work for you?

patrol test --target integration_test/login_test.dart --flavor dev --verbose

Between the config//GoogleService-Info.plist there it should be 'dev', which we get from an environment string.

What do you mean by environment string? Either:

1. Environment variable on your PC. E.g. $ export SOME_VAR=VALUE

or:

2. A constant passed into the app using e.g. --dart-define and retrieved with e.g. const String.fromEnvironment().

I'm pretty sure that the message about GoogleService-Info.plist ("Between the config//GoogleService-Info.plist there it should be 'dev', which we get from an environment string.") is shown when you're building your app. At this point, the --dart-defines (and keys from .patrol.env, and --dart-define-from-file as well) are not present.

Please clarify your problem so I can help better.

I think it would be a good idea to add the --dart-define-from-file to facilitate this, but shouldn't also adding all the keys into the .patrol.env have the same effect?

It indeed should have the same effect. Nevertheless, we should add --dart-define-from-file to patrol test, patrol build, and patrol develop.

[anfernandezz]

how do you normally build your app? What command do you use?

Usually, I run it by clicking the vs code play button haha, but I tried with a command and this one works:
fvm flutter run --dart-define-from-file=dart_defines/dev.json

Did you do some configuration in Xcode to make it pick up the correct path for GoogleService-Info.plist? Please share as much details as possible.

Yes! I don't really know much about config, but after doing some research, we have a sh build script, that runs and it's actually the one logging the error:

copy-firebase-config.sh

# Name and path of the resource we're copying
GOOGLESERVICE_INFO_PLIST=GoogleService-Info.plist
GOOGLESERVICE_INFO_FILE=${PROJECT_DIR}/config/${DART_DEFINE_FLUTTER_FLAVOR}/${GOOGLESERVICE_INFO_PLIST}

# Make sure GoogleService-Info.plist exists
echo "Looking for ${GOOGLESERVICE_INFO_PLIST} in ${GOOGLESERVICE_INFO_FILE}"
if [ ! -f $GOOGLESERVICE_INFO_FILE ]
then
echo "No GoogleService-Info.plist found. Please ensure it's in the proper directory."
exit 1
fi

# Get a reference to the destination location for the GoogleService-Info.plist
# This is the default location where Firebase init code expects to find GoogleServices-Info.plist file
PLIST_DESTINATION=${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}.app
echo "Will copy ${GOOGLESERVICE_INFO_PLIST} to final destination: ${PLIST_DESTINATION}"

# Copy over the prod GoogleService-Info.plist for Release builds
cp "${GOOGLESERVICE_INFO_FILE}" "${PLIST_DESTINATION}"
 

I will try researching more, but this is what I got so far :)

[bartekpacia]

Thanks again for more info, this clears up a lot.

The --dart-defines from the flutter build ios invocation end up in ios/Flutter/Generated.xcconfig (they're base64-encoded). Could you run patrol test ... again and after it finishes (fails), copy contents of this file and paste it?

I just want to make sure that the dart defines indeed end up there.

Regarding copy-firebase-config.sh – I understand it's in a "Run Script" Build Phase in Xcode, right? In case you don't know, I mean something this:

[anfernandezz]

Regarding copy-firebase-config.sh – I understand it's in a "Run Script" Build Phase in Xcode, right? In case you don't know, I mean something this:

Yes! We have a build phase that runs the script I showed before.

And here are the contents of the generated file:

// This is a generated file; do not edit or check into version control.
FLUTTER_ROOT=/Users/anafernandez/fvm/versions/3.10.0
FLUTTER_APPLICATION_PATH=/Users/anafernandez/workspace/myproject/myproject
COCOAPODS_PARALLEL_CODE_SIGN=true
FLUTTER_TARGET=/Users/anafernandez/workspace/myproject/myproject/integration_test/test_bundle.dart
FLUTTER_BUILD_DIR=build
FLUTTER_BUILD_NAME=1.11.1
FLUTTER_BUILD_NUMBER=89299685
EXCLUDED_ARCHS[sdk=iphonesimulator*]=i386
EXCLUDED_ARCHS[sdk=iphoneos*]=armv7
DART_DEFINES=REFSVF9ERUZJTkVfRkxVVFRFUl9GTEFWT1I9ZGV2,UEFUUk9MX1dBSVQ9MA==,SU5URUdSQVRJT05fVEVTVF9TSE9VTERfUkVQT1JUX1JFU1VMVFNfVE9fTkFUSVZFPWZhbHNl,UEFUUk9MX1RFU1RfTEFCRUxfRU5BQkxFRD10cnVl
DART_OBFUSCATION=false
TRACK_WIDGET_CREATION=false
TREE_SHAKE_ICONS=false
PACKAGE_CONFIG=/Users/anafernandez/workspace/myproject/myproject/.dart_tool/package_config.json

[bartekpacia]

It looks correct. The first value in DART_DEFINES is REFSVF9ERUZJTkVfRkxVVFRFUl9GTEFWT1I9ZGV2, which base64 --decoded gives DART_DEFINE_FLUTTER_FLAVOR=dev.

Could you try doing:

$ export DART_DEFINE_FLUTTER_FLAVOR=dev
$ patrol test --target integration_test/login_test.dart --verbose

I think the Xcode build process will pick up the DART_DEFINE_FLUTTER_FLAVOR env var and your Build Phase script should work. This is a workaround, but let's try.

[anfernandezz]

hey Barket! That seems to have done something whoop whoop, I added all the keys in the .patrol.env and did the export command for all of them, this is the new build error I'm getting (I can't show it complete as it shows the value of the env keys I have added):

$ xcodebuild build-for-testing -workspace Runner.xcworkspace -scheme Runner -configuration Debug -sdk iphonesimulator -destination generic/platform=iOS Simulator -quiet -derivedDataPath ../build/ios_integ OTHER_SWIFT_FLAGS=$(inherited) -D PATROL_ENABLED
        warning: The application supports opening files, but doesn't declare whether it supports opening them in place. You can add an LSSupportsOpeningDocumentsInPlace entry or an UISupportsDocumentBrowser entry to your Info.plist to declare support. (in target 'Runner' from project 'Runner')
        warning: The CFBundleShortVersionString of an app extension ('1.0') must match that of its containing parent app ('1.11.1').
        error: Build input file cannot be found: '/Users/anafernandez/workspace/myproject/myproject/ios/RunnerUITests/RunnerUITestsLaunchTests.m'. Did you forget to declare this file as an output of a script phase or custom build rule which produces it? (in target 'RunnerUITests' from project 'Runner')
        error: Build input file cannot be found: '/Users/anafernandez/workspace/myproject/myproject/ios/RunnerUITests/RunnerUITestsLaunchTests.m'. Did you forget to declare this file as an output of a script phase or custom build rule which produces it? (in target 'RunnerUITests' from project 'Runner')
        note: Building targets in dependency order
        note: Run script build phase 'Run Script' will be run during every build because the option to run the script phase "Based on dependency analysis" is unchecked. (in target 'Runner' from project 'Runner')
        warning: Run script build phase 'Copy Firebase Config (GoogleService-Info.plist)' will be run during every build because it does not specify any outputs. To address this warning, either add output dependencies to the script phase, or configure it to run in every build by unchecking "Based on dependency analysis" in the script phase. (in target 'Runner' from project 'Runner')
        note: Run script build phase 'Thin Binary' will be run during every build because the option to run the script phase "Based on dependency analysis" is unchecked. (in target 'Runner' from project 'Runner')
        warning: Run script build phase 'xcode_backend build' will be run during every build because it does not specify any outputs. To address this warning, either add output dependencies to the script phase, or configure it to run in every build by unchecking "Based on dependency analysis" in the script phase. (in target 'RunnerUITests' from project 'Runner')
        warning: Run script build phase 'xcode_backend embed_and_thin' will be run during every build because it does not specify any outputs. To address this warning, either add output dependencies to the script phase, or configure it to run in every build by unchecking "Based on dependency analysis" in the script phase. (in target 'RunnerUITests' from project 'Runner')
        ** TEST BUILD FAILED **

✗ Failed to build app with entrypoint test_bundle.dart for iOS simulator (xcodebuild exited with code 65) (58.0s)
Error: xcodebuild exited with code 65
#0      throwToolExit (package:patrol_cli/src/base/exceptions.dart:7:3)
#1      IOSTestBackend.build.<anonymous closure> (package:patrol_cli/src/ios/ios_test_backend.dart:127:9)
<asynchronous suspension>
#2      DisposeScope.run (package:dispose_scope/src/dispose_scope.dart:46:7)
<asynchronous suspension>
#3      IOSTestBackend.build (package:patrol_cli/src/ios/ios_test_backend.dart:67:5)
<asynchronous suspension>
#4      TestCommand._builderFor.<anonymous closure> (package:patrol_cli/src/commands/test.dart:231:9)
<asynchronous suspension>
#5      _NativeTestRunner.run.runTestsOnDevice (package:patrol_cli/src/test_runner.dart:232:13)
<asynchronous suspension>
#6      Future.wait.<anonymous closure> (dart:async/future.dart:525:21)
<asynchronous suspension>
#7      _NativeTestRunner.run (package:patrol_cli/src/test_runner.dart:260:5)
<asynchronous suspension>
#8      TestCommand.run (package:patrol_cli/src/commands/test.dart:194:21)
<asynchronous suspension>
#9      CommandRunner.runCommand (package:args/command_runner.dart:212:13)
<asynchronous suspension>
#10     PatrolCommandRunner.runCommand (package:patrol_cli/src/runner/patrol_command_runner.dart:314:18)
<asynchronous suspension>
#11     PatrolCommandRunner.run (package:patrol_cli/src/runner/patrol_command_runner.dart:258:18)
<asynchronous suspension>
#12     patrolCommandRunner (package:patrol_cli/src/runner/patrol_command_runner.dart:73:20)
<asynchronous suspension>
#13     main (file:///Users/anafernandez/.pub-cache/hosted/pub.dev/patrol_cli-2.0.0/bin/main.dart:6:20)
<asynchronous suspension>

[anfernandezz]

I wonder if I did a step wrong in the config, I removed the RunnerUITestsLaunchTests.m file as stated by the setup instructions, added the build phases, also made sure RunnerUITests had the same base build config in xcode

[bartekpacia]

Hmm, did you delete RunnerUITestsLaunchTests.m through Xcode? If has to be deleted through Xcode. If you do it e.g. with rm, then it still stays in some Xcode's files and may cause errors like the one you're getting.

[anfernandezz]

it was that, it is working now :)! thank you so much @bartekpacia!! I really appreciate it.