GPTDriver Test Suite Automation Scripts #1539
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
+12
to
+149
| runs-on: macos-latest | ||
| steps: | ||
| # --- Step 1: Extract version from branch name --- | ||
| - name: Extract version from branch name | ||
| id: extract_version_step | ||
| run: | | ||
| BRANCH_NAME="${{ github.ref }}" | ||
| # Remove 'refs/heads/' prefix (e.g., refs/heads/Release-0.0.0 -> Release-0.0.0) | ||
| BRANCH_NAME_WITHOUT_PREFIX="${BRANCH_NAME#refs/heads/}" | ||
| # Extract version after "Release-" (e.g., Release-0.0.0 -> 0.0.0) | ||
| VERSION=$(echo "$BRANCH_NAME_WITHOUT_PREFIX" | sed -n 's/^Release-\([0-9]*\.[0-9]*\.[0-9]*\)$/\1/p') | ||
|
|
||
| if [ -z "$VERSION" ]; then | ||
| echo "Error: Could not extract version from branch name '$BRANCH_NAME_WITHOUT_PREFIX'. Expected format: Release-X.Y.Z" | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "Extracted versionName: $VERSION" | ||
| echo "VERSION_STRING=$VERSION" >> $GITHUB_ENV | ||
|
|
||
| # Convert semantic version to an integer for CFBundleVersion (versionCode equivalent) | ||
| # Example: 1.2.3 -> 102003 (assuming max 2 digits for minor/patch) | ||
| # This should be adjusted based on the maximum expected values for major/minor/patch | ||
| MAJOR=$(echo "$VERSION" | cut -d. -f1) | ||
| MINOR=$(echo "$VERSION" | cut -d. -f2) | ||
| PATCH=$(echo "$VERSION" | cut -d. -f3) | ||
|
|
||
| # Calculate versionCode (CFBundleVersion) - ensure this fits in a 32-bit integer | ||
| # Standard Android-like conversion: Major * 10000 + Minor * 100 + Patch | ||
| # This provides sufficient uniqueness for most common versioning schemes. | ||
| VERSION_CODE_INT=$(( MAJOR * 10000 + MINOR * 100 + PATCH )) | ||
| echo "Calculated versionCode: $VERSION_CODE_INT" | ||
| echo "VERSION_CODE_INT=$VERSION_CODE_INT" >> $GITHUB_ENV | ||
|
|
||
|
|
||
| # --- Step 2: Checkout the iOS Branch SDK repository --- | ||
| - name: Checkout BranchMetrics/ios-branch-deep-linking-attribution (SDK) | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| repository: BranchMetrics/ios-branch-deep-linking-attribution | ||
| ref: ${{ github.ref }} # Use the same branch that triggered the workflow | ||
| path: ./branch-ios-sdk-repo # Checkout into a subdirectory | ||
|
|
||
| # --- Step 3: Build the iOS Branch SDK Framework --- | ||
| - name: Build Branch SDK Framework | ||
| run: | | ||
| # Build for simulator. Adjust scheme if necessary. | ||
| # The output framework will be in build/Debug-iphonesimulator/BranchSDK.framework | ||
| xcodebuild -scheme xcframework \ | ||
| BUILD_DIR="${{ github.workspace }}/branch-ios-sdk-repo/build" | ||
| working-directory: ./branch-ios-sdk-repo | ||
|
|
||
| # --- Step 4: Checkout the iOS Branch Link Simulator App repository --- | ||
| - name: Checkout BranchMetrics/BranchLinkSimulator (App) | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| repository: BranchMetrics/BranchLinkSimulator | ||
| ref: gptdriver/linkingTests # Checkout the specific app branch | ||
| path: ./ios-app-repo # Checkout into another subdirectory | ||
|
|
||
| # --- Step 5: Copy the generated SDK Framework to the App's project --- | ||
| - name: Copy generated SDK Framework to App's libs directory | ||
| run: | | ||
| # Create a 'Frameworks' directory within the app repo for the local SDK | ||
| mkdir -p ./ios-app-repo/Frameworks | ||
| # Copy the built framework | ||
| cp -R ./branch-ios-sdk-repo/build/BranchSDK.xcframework ./ios-app-repo/Frameworks/ | ||
| working-directory: ${{ github.workspace }} # Run from the root of the GITHUB_WORKSPACE | ||
|
|
||
| # --- Step 6: Install Code Sign Certificate and Provisioning profile | ||
| - name: Install the Apple certificate and provisioning profile | ||
| env: | ||
| BUILD_CERTIFICATE_BASE64: ${{ secrets.BS_BUILD_CERTIFICATE }} | ||
| P12_PASSWORD: ${{ secrets.BS_P12_PASSWORD }} | ||
| BUILD_PROVISION_PROFILE_BASE64: ${{ secrets.BS_BUILD_PROVISION_PROFILE_BASE64_PART_AA }} | ||
| KEYCHAIN_PASSWORD: ${{ secrets.KEYCHAIN_PASSWORD }} | ||
| run: | | ||
| # create variables | ||
| CERTIFICATE_PATH=$RUNNER_TEMP/build_certificate.p12 | ||
| KEYCHAIN_PATH=$RUNNER_TEMP/app-signing.keychain-db | ||
| PP_PATH=$RUNNER_TEMP/build_pp.mobileprovision | ||
|
|
||
| # import certificate | ||
| echo -n "$BUILD_CERTIFICATE_BASE64" | base64 --decode -o $CERTIFICATE_PATH | ||
|
|
||
| # Create Provisioning Profiles | ||
| echo "${{ secrets.BS_BUILD_PROVISION_PROFILE_BASE64_PART_AA }}" >> part_aa | ||
| #echo "${{ secrets.BS_BUILD_PROVISION_PROFILE_BASE64_PART_AB }}" >> part_aa | ||
| #echo "${{ secrets.BS_BUILD_PROVISION_PROFILE_BASE64_PART_AC }}" >> part_aa | ||
| base64 -D -i part_aa > $PP_PATH | ||
|
|
||
| # create temporary keychain | ||
| security create-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH | ||
| security set-keychain-settings -lut 21600 $KEYCHAIN_PATH | ||
| security unlock-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH | ||
|
|
||
| # import certificate to keychain | ||
| security import $CERTIFICATE_PATH -P "$P12_PASSWORD" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH | ||
| security list-keychain -d user -s $KEYCHAIN_PATH | ||
|
|
||
| # apply provisioning profile | ||
| mkdir -p ~/Library/Developer/Xcode/UserData/Provisioning\ Profiles | ||
| cp $PP_PATH ~/Library/Developer/Xcode/UserData/Provisioning\ Profiles/ | ||
|
|
||
| # --- Step 6: Build the iOS Branch Link Simulator App using the local SDK Framework --- | ||
| - name: Build iOS App with local SDK | ||
| run: | | ||
| # Build the app. Adjust project/workspace, scheme, and destination if necessary. | ||
| # We're passing MARKETING_VERSION (versionName) and CURRENT_PROJECT_VERSION (versionCode) | ||
| xcodebuild -scheme BranchLinkSimulator -allowProvisioningUpdates \ | ||
| MARKETING_VERSION=${{ env.VERSION_STRING }} \ | ||
| CURRENT_PROJECT_VERSION=${{ env.VERSION_CODE_INT }} \ | ||
| -sdk iphoneos archive -archivePath ./IPA/BranchLinkSimulator.xcarchive | ||
| xcodebuild -exportArchive -archivePath ./IPA/BranchLinkSimulator.xcarchive -exportOptionsPlist IPA/Info.plist -exportPath IPA/ | ||
| working-directory: ./ios-app-repo | ||
|
|
||
| # --- Step 7: Echo the location of the generated .app bundle --- | ||
| - name: Echo .app bundle location | ||
| run: | | ||
| APP_PATH="./ios-app-repo/IPA/BranchLinkSimulator.ipa" | ||
| echo "Generated IPA location: $APP_PATH" | ||
|
|
||
| # --- Step 8: Upload Build Artifacts --- | ||
| - name: Upload Build Artifacts | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: BranchLinkSimulator-iOS-Debug-Build | ||
| path: ./ios-app-repo/IPA/BranchLinkSimulator.ipa | ||
|
|
||
| # --- Step 9: Run tests on GPTDriver service. --- | ||
| - name: Run GPTDriver tests | ||
| run: | | ||
| chmod +x ./branch-ios-sdk-repo/.github/gptdriverrunscript.sh | ||
| ./branch-ios-sdk-repo/.github/gptdriverrunscript.sh ./ios-app-repo/IPA/BranchLinkSimulator.ipa ios | ||
| env: | ||
| API_ORG_KEY: ${{ secrets.MOBILEBOOST_API_ORG_KEY }} | ||
| API_KEY: ${{ secrets.MOBILEBOOST_API_ORG_KEY }} | ||
| TEST_TAGS: ios |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Show autofix suggestion
Hide autofix suggestion
Copilot Autofix
AI 22 days ago
To fix this issue, we need to explicitly set the permissions key in the workflow file to restrict the permissions granted to the GITHUB_TOKEN in the workflow. The minimal, safest starting point is contents: read, which grants read-only repository access. Since this workflow checks out code, builds, signs, and uploads artifacts, but does not push changes, open issues, or create pull requests, the minimal contents: read permission is appropriate. This should be added at the root level of the workflow file (after name: and before on:), which will affect all jobs unless overridden.
No changes to functionality will occur with this update, and all workflow steps will continue to work as before, but potential write access to repository content will be removed.
Suggested changeset
1
.github/workflows/gpt-driver-tests.yml
| @@ -1,4 +1,6 @@ | ||
| name: GPTDriver Test Suite Automation | ||
| permissions: | ||
| contents: read | ||
|
|
||
| on: | ||
| workflow_dispatch: |
Copilot is powered by AI and may make mistakes. Always verify output.
|
Summary By MatterAI
🔄 What ChangedAdded automation scripts for GPTDriver test suite execution via GitHub Actions. Introduced 🔍 Impact of the ChangeEnables fully automated testing of iOS builds on GPTDriver upon pushing to 📁 Total Files Changed
🧪 Test Added
🔒 Security Vulnerabilities
Tip Quality Recommendations
Tanka Poem ♫
Sequence DiagramsequenceDiagram
participant GHA as GitHub Actions
participant Script as gptdriverrunscript.sh
participant API as GPTDriver API
participant SDK as Branch SDK
participant App as BranchLinkSimulator App
Note over GHA: Trigger on push to Release-*
GHA->>GHA: Extract version from branch
GHA->>SDK: Build xcframework
GHA->>App: Checkout & inject SDK
GHA->>GHA: Sign app with cert + profile
GHA->>GHA: Build IPA
GHA->>Script: Run with IPA path, platform
Script->>API: POST /uploadBuild (multipart)
API-->>Script: {buildId, app_link}
Script->>API: POST /tests/execute {organisationId, uploadId, tags}
API-->>Script: {test_suite_ids[0]}
Script->>API: GET /testSuiteRuns/{id}/gh (polling)
alt Status = completed
API-->>Script: {status: completed, result: succeeded}
Script-->>GHA: exit 0
else Timeout or failure
Script-->>GHA: exit 1
end
Script->>GHA: Write markdown to GITHUB_STEP_SUMMARY
|
|
Important PR Review SkippedPR review skipped as per the configuration setting. Run a manually review by commenting /matter review 💡Tips to use MatterAICommand List
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference
SDK-XXXX -- <TITLE>.
Summary
Motivation
Type Of Change
Testing Instructions
cc @BranchMetrics/saas-sdk-devs for visibility.