Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PM-9375] Build a debug-for-simulator version of the app for easier automated testing #1151

Open
wants to merge 46 commits into
base: main
Choose a base branch
from

Conversation

KatherineInCode
Copy link
Contributor

🎟️ Tracking

https://bitwarden.atlassian.net/browse/PM-9375

📔 Objective

In order to run automated tests without locally downloading Xcode and running the tests manually, the QA folks need a debug build that can be downloaded and installed on an arbitrary simulator. This flow produces this build as part of the standard CI flow, along with adding a workflow that can be called separately.

I debated between making this a separate flow (and script) instead of just using the current build.yml, but ultimately I felt like the differences between them were too great. There are a lot of steps that don't need to happen for a simulator build, and the xcodebuild invocation is sufficiently different that it seemed reasonable to keep it separate. I also thought it was more likely that we would potentially pull this invocation out of the CI main workflow and set up an alternate set of triggers for it, depending on QA's needs, and having a separately invocable action makes that easier. However, at some point in the future that calculus might change and it might make more sense to merge this with the build.yml workflow.

There are also some minor touch-ups to the build.sh script: removing dead code, fixing a capitalization error, and adding more explicit logging.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

Copy link
Contributor

github-actions bot commented Nov 19, 2024

Logo
Checkmarx One – Scan Summary & Details226a0237-3ec6-42c5-a45d-3f279366e014

No New Or Fixed Issues Found

Copy link

codecov bot commented Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.47%. Comparing base (4d9d912) to head (327bcc3).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1151   +/-   ##
=======================================
  Coverage   89.47%   89.47%           
=======================================
  Files         688      688           
  Lines       43811    43811           
=======================================
  Hits        39202    39202           
  Misses       4609     4609           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Scripts/build-sim.sh Outdated Show resolved Hide resolved
Scripts/build-sim.sh Outdated Show resolved Hide resolved
Scripts/build.sh Outdated Show resolved Hide resolved
.github/workflows/build.yml Outdated Show resolved Hide resolved
.github/workflows/build.yml Outdated Show resolved Hide resolved
vvolkgang
vvolkgang previously approved these changes Nov 27, 2024
Copy link
Member

@vvolkgang vvolkgang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏾

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants