Skip to content
This repository was archived by the owner on Feb 5, 2025. It is now read-only.

Commit ab628c0

Browse files
mokagiomokagio
committed
Add build phase that generates credentials for demo app
1 parent 97f15b6 commit ab628c0

File tree

5 files changed

+213
-0
lines changed

5 files changed

+213
-0
lines changed

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,5 @@ fastlane/test_output
4242
# Everything without a .enc extension is ignored
4343
.configure-files/*
4444
!.configure-files/*.enc
45+
# If the user created a local secrets file, ignore it
46+
Demo/Secrets.swift

‎Demo/AuthenticatorDemo.xcodeproj/project.pbxproj‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,23 @@
66
objectVersion = 56;
77
objects = {
88

9+
/* Begin PBXAggregateTarget section */
10+
3F27A54E291AE3CF0000996B /* GenerateCredentials */ = {
11+
isa = PBXAggregateTarget;
12+
buildConfigurationList = 3F27A54F291AE3CF0000996B /* Build configuration list for PBXAggregateTarget "GenerateCredentials" */;
13+
buildPhases = (
14+
3F27A552291AE3D60000996B /* Generate Credentials */,
15+
);
16+
dependencies = (
17+
);
18+
name = GenerateCredentials;
19+
productName = GenerateCredentials;
20+
};
21+
/* End PBXAggregateTarget section */
22+
923
/* Begin PBXBuildFile section */
1024
0B9084355AE56CADE54CE018 /* Pods_AuthenticatorDemo.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = AF02C0C8B7B005AAE3C08BD9 /* Pods_AuthenticatorDemo.framework */; };
25+
3F27A556291AE5F00000996B /* Secrets.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3F27A555291AE5F00000996B /* Secrets.swift */; };
1126
3F55C3A8292BAAE0002923B1 /* CellConfiguration.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3F55C3A7292BAAE0002923B1 /* CellConfiguration.swift */; };
1227
3F55C3AD292BAB23002923B1 /* UIViewController+Presentation.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3F55C3AB292BAB23002923B1 /* UIViewController+Presentation.swift */; };
1328
3F55C3AE292BAB23002923B1 /* UIAlertController+Utils.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3F55C3AC292BAB23002923B1 /* UIAlertController+Utils.swift */; };
@@ -19,7 +34,18 @@
1934
3FB5B6FB2912420F00F40408 /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 3FB5B6F92912420F00F40408 /* LaunchScreen.storyboard */; };
2035
/* End PBXBuildFile section */
2136

37+
/* Begin PBXContainerItemProxy section */
38+
3F27A553291AE4030000996B /* PBXContainerItemProxy */ = {
39+
isa = PBXContainerItemProxy;
40+
containerPortal = 3FB5B6E32912420E00F40408 /* Project object */;
41+
proxyType = 1;
42+
remoteGlobalIDString = 3F27A54E291AE3CF0000996B;
43+
remoteInfo = GenerateCredentials;
44+
};
45+
/* End PBXContainerItemProxy section */
46+
2247
/* Begin PBXFileReference section */
48+
3F27A555291AE5F00000996B /* Secrets.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = Secrets.swift; path = ../Secrets.swift; sourceTree = BUILT_PRODUCTS_DIR; };
2349
3F55C3A7292BAAE0002923B1 /* CellConfiguration.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CellConfiguration.swift; sourceTree = "<group>"; };
2450
3F55C3AB292BAB23002923B1 /* UIViewController+Presentation.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "UIViewController+Presentation.swift"; sourceTree = "<group>"; };
2551
3F55C3AC292BAB23002923B1 /* UIAlertController+Utils.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "UIAlertController+Utils.swift"; sourceTree = "<group>"; };
@@ -75,6 +101,7 @@
75101
3FB5B6FC2912420F00F40408 /* Info.plist */,
76102
3FB5B6F92912420F00F40408 /* LaunchScreen.storyboard */,
77103
3FB5B6F02912420E00F40408 /* SceneDelegate.swift */,
104+
3F27A555291AE5F00000996B /* Secrets.swift */,
78105
3F55C3AC292BAB23002923B1 /* UIAlertController+Utils.swift */,
79106
3F55C3AB292BAB23002923B1 /* UIViewController+Presentation.swift */,
80107
3FB5B6F22912420E00F40408 /* ViewController.swift */,
@@ -117,6 +144,7 @@
117144
buildRules = (
118145
);
119146
dependencies = (
147+
3F27A554291AE4030000996B /* PBXTargetDependency */,
120148
);
121149
name = AuthenticatorDemo;
122150
productName = AuthenticatorDemo;
@@ -133,6 +161,9 @@
133161
LastSwiftUpdateCheck = 1400;
134162
LastUpgradeCheck = 1400;
135163
TargetAttributes = {
164+
3F27A54E291AE3CF0000996B = {
165+
CreatedOnToolsVersion = 14.1;
166+
};
136167
3FB5B6EA2912420E00F40408 = {
137168
CreatedOnToolsVersion = 14.0.1;
138169
};
@@ -152,6 +183,7 @@
152183
projectRoot = "";
153184
targets = (
154185
3FB5B6EA2912420E00F40408 /* AuthenticatorDemo */,
186+
3F27A54E291AE3CF0000996B /* GenerateCredentials */,
155187
);
156188
};
157189
/* End PBXProject section */
@@ -169,6 +201,26 @@
169201
/* End PBXResourcesBuildPhase section */
170202

171203
/* Begin PBXShellScriptBuildPhase section */
204+
3F27A552291AE3D60000996B /* Generate Credentials */ = {
205+
isa = PBXShellScriptBuildPhase;
206+
buildActionMask = 2147483647;
207+
files = (
208+
);
209+
inputFileListPaths = (
210+
"$(SRCROOT)/Build-Phases/GenerateCredentials.xcfilelist",
211+
);
212+
inputPaths = (
213+
);
214+
name = "Generate Credentials";
215+
outputFileListPaths = (
216+
);
217+
outputPaths = (
218+
"$(BUILD_DIR)/Secrets.swift",
219+
);
220+
runOnlyForDeploymentPostprocessing = 0;
221+
shellPath = /bin/sh;
222+
shellScript = "$SRCROOT/Build-Phases/GenerateCredentials.sh\n";
223+
};
172224
46F868D4B05D9FAC769EF4C5 /* [CP] Embed Pods Frameworks */ = {
173225
isa = PBXShellScriptBuildPhase;
174226
buildActionMask = 2147483647;
@@ -216,6 +268,7 @@
216268
buildActionMask = 2147483647;
217269
files = (
218270
3F55C3AD292BAB23002923B1 /* UIViewController+Presentation.swift in Sources */,
271+
3F27A556291AE5F00000996B /* Secrets.swift in Sources */,
219272
3FB5B6F32912420E00F40408 /* ViewController.swift in Sources */,
220273
3FB5B6EF2912420E00F40408 /* AppDelegate.swift in Sources */,
221274
3F55C3A8292BAAE0002923B1 /* CellConfiguration.swift in Sources */,
@@ -227,6 +280,14 @@
227280
};
228281
/* End PBXSourcesBuildPhase section */
229282

283+
/* Begin PBXTargetDependency section */
284+
3F27A554291AE4030000996B /* PBXTargetDependency */ = {
285+
isa = PBXTargetDependency;
286+
target = 3F27A54E291AE3CF0000996B /* GenerateCredentials */;
287+
targetProxy = 3F27A553291AE4030000996B /* PBXContainerItemProxy */;
288+
};
289+
/* End PBXTargetDependency section */
290+
230291
/* Begin PBXVariantGroup section */
231292
3FB5B6F92912420F00F40408 /* LaunchScreen.storyboard */ = {
232293
isa = PBXVariantGroup;
@@ -239,6 +300,25 @@
239300
/* End PBXVariantGroup section */
240301

241302
/* Begin XCBuildConfiguration section */
303+
3F55C3B3292BABF8002923B1 /* Debug */ = {
304+
isa = XCBuildConfiguration;
305+
buildSettings = {
306+
COPY_PHASE_STRIP = NO;
307+
GCC_DYNAMIC_NO_PIC = NO;
308+
GCC_OPTIMIZATION_LEVEL = 0;
309+
PRODUCT_NAME = GenerateCredentials;
310+
};
311+
name = Debug;
312+
};
313+
3F55C3B4292BABF8002923B1 /* Release */ = {
314+
isa = XCBuildConfiguration;
315+
buildSettings = {
316+
COPY_PHASE_STRIP = YES;
317+
DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
318+
PRODUCT_NAME = GenerateCredentials;
319+
};
320+
name = Release;
321+
};
242322
3FB5B6FD2912420F00F40408 /* Debug */ = {
243323
isa = XCBuildConfiguration;
244324
buildSettings = {
@@ -410,6 +490,15 @@
410490
/* End XCBuildConfiguration section */
411491

412492
/* Begin XCConfigurationList section */
493+
3F27A54F291AE3CF0000996B /* Build configuration list for PBXAggregateTarget "GenerateCredentials" */ = {
494+
isa = XCConfigurationList;
495+
buildConfigurations = (
496+
3F55C3B3292BABF8002923B1 /* Debug */,
497+
3F55C3B4292BABF8002923B1 /* Release */,
498+
);
499+
defaultConfigurationIsVisible = 0;
500+
defaultConfigurationName = Release;
501+
};
413502
3FB5B6E62912420E00F40408 /* Build configuration list for PBXProject "AuthenticatorDemo" */ = {
414503
isa = XCConfigurationList;
415504
buildConfigurations = (

‎Demo/AuthenticatorDemo/Secrets.example.swift‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import Foundation
2+
3+
@objc
4+
class ApiCredentials: NSObject {
5+
6+
// WordPress.com OAuth ClientID / Client Secret
7+
static let client = "0"
8+
static let secret = ""
9+
10+
// Google Login
11+
static let googleLoginClientId = ""
12+
static let googleLoginSchemeId = ""
13+
static let googleLoginServerClientId = ""
14+
}

‎Demo/Build-Phases/GenerateCredentials.sh‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
#!/bin/bash -eu
2+
3+
# This is a streamlined version of the script by the same name in the
4+
# WordPress iOS repo.
5+
#
6+
# Before modifying this, checkout the original to see if there have been
7+
# improvements.
8+
#
9+
# https://github.com/wordpress-mobile/WordPress-iOS/blob/a81ed8b7c0fa91689431178ba132813f082c67da/Scripts/BuildPhases/GenerateCredentials.sh
10+
11+
SECRETS_ROOT="${HOME}/.configure/wordpress-authenticator-ios-demo/secrets"
12+
13+
# To help the Xcode build system optimize the build, we want to ensure each of
14+
# the secrets to copy is defined as an input file for the run script build
15+
# phase.
16+
#
17+
# > The Xcode Build System will use [these files] to determine if your run
18+
# > scripts should actually run or not. So this should include any file that
19+
# > your run script phase, the script content, is actually going to read or
20+
# > look at during its process.
21+
#
22+
# > If you have no input files declared, the Xcode build system will need to
23+
# > run your run script phase on every single build.
24+
#
25+
# https://developer.apple.com/videos/play/wwdc2018/408/
26+
function ensure_is_in_input_files_list() {
27+
# Loop through the file input lists looking for $1. If not found, fail the
28+
# build.
29+
if [ -z "$1" ]; then
30+
echo "error: Input file list verification needs a path to verify!"
31+
exit 1
32+
fi
33+
file_to_find=$1
34+
35+
i=0
36+
found=false
37+
while [[ $i -lt $SCRIPT_INPUT_FILE_LIST_COUNT && "$found" = false ]]
38+
do
39+
# Need this two step process to access the input at index
40+
file_list_resolved_var_name=SCRIPT_INPUT_FILE_LIST_${i}
41+
# The following reads the processed xcfilelist line by line looking for
42+
# the given file
43+
while read -r input_file; do
44+
if [ "$file_to_find" == "$input_file" ]; then
45+
found=true
46+
break
47+
fi
48+
done <"${!file_list_resolved_var_name}"
49+
(( i=i+1 ))
50+
done
51+
if [ "$found" = false ]; then
52+
echo "error: Could not find $file_to_find as an input to the build phase. Add $file_to_find to the input files list using the .xcfilelist."
53+
exit 1
54+
fi
55+
}
56+
57+
SECRETS_FILE="${SECRETS_ROOT}/Secrets.swift"
58+
ensure_is_in_input_files_list "$SECRETS_FILE"
59+
60+
LOCAL_SECRETS_FILE="${SRCROOT}/Secrets.swift"
61+
EXAMPLE_SECRETS_FILE="${SRCROOT}/AuthenticatorDemo/Secrets.example.swift"
62+
ensure_is_in_input_files_list "$EXAMPLE_SECRETS_FILE"
63+
64+
SECRETS_DESTINATION_FILE="${BUILD_DIR}/Secrets.swift"
65+
mkdir -p "$(dirname "$SECRETS_DESTINATION_FILE")"
66+
67+
# If the secrets are available, use them
68+
if [ -f "$SECRETS_FILE" ]; then
69+
echo "Applying secrets"
70+
cp -v "$SECRETS_FILE" "${SECRETS_DESTINATION_FILE}"
71+
exit 0
72+
fi
73+
74+
# If the developer has a local secrets file, use it
75+
if [ -f "$LOCAL_SECRETS_FILE" ]; then
76+
echo "warning: Using local secrets from $LOCAL_SECRETS_FILE. If you are an external contributor, this is expected and you can ignore this warning. If you are an internal contributor, make sure to use our shared credentials instead."
77+
echo "Applying local secrets"
78+
cp -v "$LOCAL_SECRETS_FILE" "${SECRETS_DESTINATION_FILE}"
79+
exit 0
80+
fi
81+
82+
# None of the above secrets was found. Use the example secrets file as a last
83+
# resort.
84+
85+
COULD_NOT_FIND_SECRET_MSG="Could not find secrets file at ${SECRETS_DESTINATION_FILE}. This is likely due to the source secrets being missing from ${SECRETS_ROOT}"
86+
INTERNAL_CONTRIBUTOR_MSG="If you are an internal contributor, run \`bundle exec fastlane run configure_apply\` to update your secrets and try again"
87+
EXTERNAL_CONTRIBUTOR_MSG="If you are an external contributor, run \`cp $EXAMPLE_SECRETS_FILE $LOCAL_SECRETS_FILE\` to create a local secrets file and then add your own credentials in it (the file is ignored by Git)"
88+
89+
echo "warning: $COULD_NOT_FIND_SECRET_MSG. Falling back to $EXAMPLE_SECRETS_FILE. $INTERNAL_CONTRIBUTOR_MSG. $EXTERNAL_CONTRIBUTOR_MSG."
90+
echo "Applying example secrets"
91+
cp -v "$EXAMPLE_SECRETS_FILE" "${SECRETS_DESTINATION_FILE}"

‎Demo/Build-Phases/GenerateCredentials.xcfilelist‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Lists of input files for the script that populates the app's secrets with the
2+
# correct values for the current scheme and build configuration.
3+
${HOME}/.configure/wordpress-authenticator-ios-demo/secrets/Secrets.swift
4+
5+
# Local Secrets file that external contributors can use to specify their own
6+
# ClientID and Secrets. This file is created by the Rakefile when external
7+
# contributors run the `init:oss` task and provide their own credentials.
8+
${SRCROOT}/Secrets.swift
9+
10+
# Example secrets file, we fallback to this if none of the above is avaiable.
11+
# That usually happens on new machines, to external contributors, or in CI
12+
# builds that don't need access to secrets, such as the unit tests.
13+
${SRCROOT}/AuthenticatorDemo/Secrets.example.swift
14+
15+
# Add the script that uses this file as a source, so that, if the script
16+
# changes, Xcode will run it again on the next build.
17+
${SRCROOT}/Build-Phases/GenerateCredentials.sh

0 commit comments

Comments
 (0)