Skip to content

Fix prototype_build_details_comment action when used outside FAD context #642

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.

Sign up for GitHub

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

Merged
AliSoftware merged 4 commits into from
Mar 21, 2025
Merged

Fix prototype_build_details_comment action when used outside FAD context #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
36dc5fb
Remove duplicate tests
AliSoftware Mar 20, 2025
13d8d3c
Add test to not include FAD rows if not using FAD
AliSoftware Mar 20, 2025
3138606
Fix not including FAD rows if not using FAD
AliSoftware Mar 20, 2025
7ad05fd
Add CHANGELOG entry
AliSoftware Mar 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ _None_

### Bug Fixes

_None_
- Fix an issue where `prototype_build_details_comment` added some unexpected metadata rows in the comment table if we didn't use `firebase_app_distribution` (e.g. for Prototype Builds uploaded to S3 and not using FAD) [#642]

### Internal Changes

Expand Down
9 changes: 6 additions & 3 deletions ...astlane/plugin/wpmreleasetoolkit/actions/common/prototype_build_details_comment_action.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,12 +102,15 @@ def self.from_lane_context
# @return [Hash<String, String>] A hash of all the metadata, consolidated from both the explicit and the implicit ones
#
def self.generate_metadata_hash(params:, release_info:)
# Add explicit metadata provided by the caller
metadata = params[:metadata]&.transform_keys(&:to_s) || {}

# Add Firebase-specific metadata if available
metadata['Build Number'] ||= "<code>#{release_info&.build_version}</code>"
metadata['Version'] ||= "<code>#{release_info&.display_version}</code>"
metadata[release_info&.os == 'ios' ? 'Bundle ID' : 'Application ID'] ||= "<code>#{release_info&.bundle_id}</code>"
unless release_info.nil?
Copy link
Contributor

@iangmaia iangmaia Mar 21, 2025

Choose a reason for hiding this comment

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

👍

metadata['Build Number'] ||= "<code>#{release_info.build_version}</code>"
metadata['Version'] ||= "<code>#{release_info.display_version}</code>"
metadata[release_info.os == 'ios' ? 'Bundle ID' : 'Application ID'] ||= "<code>#{release_info.bundle_id}</code>"
end

# Add git metadata
metadata['Commit'] ||= ENV.fetch('BUILDKITE_COMMIT', nil) || other_action.last_git_commit[:abbreviated_commit_hash]
Expand Down
145 changes: 63 additions & 82 deletions spec/prototype_build_details_comment_action_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,27 +111,65 @@
end
end

describe 'app_icon' do
describe 'app_icon handling' do
context 'when providing an URL' do
it 'includes the icon in the intro text' do
comment = run_described_fastlane_action(
app_display_name: 'My Cool App',
app_icon: 'https://localhost/foo.png',
download_url: 'https://localhost/foo.apk'
)
expect(comment).to include "<img align='top' src='https://localhost/foo.png' width='20px' alt='App Icon' />📲 "
comment = run_described_fastlane_action(base_params.merge(app_icon: valid_app_icon_url))
expect(comment).to include "<img align='top' src='#{valid_app_icon_url}' width='20px' alt='App Icon' />📲 "
end
end

context 'when providing an emoji code' do
it 'includes the icon in the intro text' do
comment = run_described_fastlane_action(
app_display_name: 'My Cool App',
app_icon: ':jetpack:',
download_url: 'https://localhost/foo.apk'
)
comment = run_described_fastlane_action(base_params.merge(app_icon: ':jetpack:'))
expect(comment).to include "<img align='top' src='https://raw.githubusercontent.com/buildkite/emojis/main/img-buildkite-64/jetpack.png' width='20px' alt='App Icon' />📲 "
end

it 'handles emoji codes with special characters' do
comment = run_described_fastlane_action(base_params.merge(app_icon: ':plus-one:'))
expect(comment).to include 'plus-one.png'
end
end

context 'when no icon is provided' do
context 'when using Firebase App Distribution' do
let(:firebase_release_info) do
{
displayVersion: '28.7',
buildVersion: '1287003',
testingUri: 'https://appdistribution.firebase.google.com/testerapps/1:123456:ios:abcdef/releases/xyz',
firebaseConsoleUri: 'https://console.firebase.google.com/project/apps-test/appdistribution/app/ios:com.example.myapp/releases/xyz'
}
end

before do
stub_const('Fastlane::Actions::SharedValues::FIREBASE_APP_DISTRO_RELEASE', :firebase_app_distro_release)
allow(Fastlane::Actions).to receive(:lane_context).and_return({ firebase_app_distro_release: firebase_release_info })
end

it 'uses the firebase icon' do
comment = run_described_fastlane_action(app_display_name: 'My App')
expect(comment).to include 'firebase.png'
end
end

context 'when using a Firebase download URL' do
it 'uses the firebase icon' do
comment = run_described_fastlane_action(
app_display_name: 'My App',
download_url: 'https://appdistribution.firebase.google.com/testerapps/1:123456:ios:abcdef/releases/xyz'
)
expect(comment).to include 'firebase.png'
end
end

context 'when using a non-Firebase download URL' do
it 'does not include any icon' do
comment = run_described_fastlane_action(base_params.merge(app_icon: nil))
expect(comment).not_to include 'firebase.png'
expect(comment).to match(/^<p>📲 You can test/)
end
end
end
end

Expand Down Expand Up @@ -301,6 +339,17 @@
expect(comment).to include "<td><b>Direct Download</b></td><td><a href='https://example.com/myapp.apk'><code>myapp.apk</code></a></td>"
end

it 'does not include rows for FAD metadata' do
comment = run_described_fastlane_action(
app_display_name: 'My App',
download_url: 'https://example.com/myapp.apk'
)
expect(comment).not_to include %r{<td>.*Build Number.*</td>}
expect(comment).not_to include %r{<td>.*Version.*</td>}
expect(comment).not_to include %r{<td>.*Bundle ID.*</td>}
expect(comment).not_to include %r{<td>.*Application ID.*</td>}
end

it 'does not include any default footnote if no explicit footnote is provided' do
comment = run_described_fastlane_action(
app_display_name: 'My App',
Expand Down Expand Up @@ -346,15 +395,12 @@
<p><img align='top' src='https://raw.githubusercontent.com/buildkite/emojis/main/img-buildkite-64/jetpack.png' width='20px' alt='App Icon' />📲 You can test the changes from this Pull Request in <b>The Best App</b> by scanning the QR code below to install the corresponding build.</p>
<table>
<tr>
<td rowspan='9' width='260px'><img src='https://api.qrserver.com/v1/create-qr-code/?size=500x500&qzone=4&data=https%3A%2F%2Fexample.com%2Fbestapp.apk' width='250' height='250' /></td>
<td rowspan='6' width='260px'><img src='https://api.qrserver.com/v1/create-qr-code/?size=500x500&qzone=4&data=https%3A%2F%2Fexample.com%2Fbestapp.apk' width='250' height='250' /></td>
<td><b>App Name</b></td><td>The Best App</td>
</tr>
<tr><td><b>Version Name</b></td><td>28.2</td></tr>
<tr><td><b>Version Code</b></td><td>1280200108</td></tr>
<tr><td><b>Flavor</b></td><td>Debug</td></tr>
<tr><td><b>Build Number</b></td><td><code></code></td></tr>
<tr><td><b>Version</b></td><td><code></code></td></tr>
<tr><td><b>Application ID</b></td><td><code></code></td></tr>
<tr><td><b>Commit</b></td><td>a1b2c3f</td></tr>
<tr><td><b>Direct Download</b></td><td><a href='https://example.com/bestapp.apk'><code>bestapp.apk</code></a></td></tr>
</table>
Expand All @@ -379,14 +425,11 @@
<details><summary>📲 You can test the changes from this Pull Request in <b>The Best App</b> by scanning the QR code below to install the corresponding build.</summary>
<table>
<tr>
<td rowspan='8' width='260px'><img src='https://api.qrserver.com/v1/create-qr-code/?size=500x500&qzone=4&data=https%3A%2F%2Fexample.com%2Fbestapp.apk' width='250' height='250' /></td>
<td rowspan='5' width='260px'><img src='https://api.qrserver.com/v1/create-qr-code/?size=500x500&qzone=4&data=https%3A%2F%2Fexample.com%2Fbestapp.apk' width='250' height='250' /></td>
<td><b>App Name</b></td><td>The Best App</td>
</tr>
<tr><td><b>Version Name</b></td><td>28.2</td></tr>
<tr><td><b>Version Code</b></td><td>1280200108</td></tr>
<tr><td><b>Build Number</b></td><td><code></code></td></tr>
<tr><td><b>Version</b></td><td><code></code></td></tr>
<tr><td><b>Application ID</b></td><td><code></code></td></tr>
<tr><td><b>Commit</b></td><td>a1b2c3f</td></tr>
<tr><td><b>Direct Download</b></td><td><a href='https://example.com/bestapp.apk'><code>bestapp.apk</code></a></td></tr>
</table>
Expand All @@ -395,66 +438,4 @@
EXPECTED_COMMENT
end
end

describe 'app_icon handling' do
context 'when providing an URL' do
it 'includes the icon in the intro text' do
comment = run_described_fastlane_action(base_params.merge(app_icon: valid_app_icon_url))
expect(comment).to include "<img align='top' src='#{valid_app_icon_url}' width='20px' alt='App Icon' />📲 "
end
end

context 'when providing an emoji code' do
it 'includes the icon in the intro text' do
comment = run_described_fastlane_action(base_params.merge(app_icon: ':jetpack:'))
expect(comment).to include "<img align='top' src='https://raw.githubusercontent.com/buildkite/emojis/main/img-buildkite-64/jetpack.png' width='20px' alt='App Icon' />📲 "
end

it 'handles emoji codes with special characters' do
comment = run_described_fastlane_action(base_params.merge(app_icon: ':plus-one:'))
expect(comment).to include 'plus-one.png'
end
end

context 'when no icon is provided' do
context 'when using Firebase App Distribution' do
let(:firebase_release_info) do
{
displayVersion: '28.7',
buildVersion: '1287003',
testingUri: 'https://appdistribution.firebase.google.com/testerapps/1:123456:ios:abcdef/releases/xyz',
firebaseConsoleUri: 'https://console.firebase.google.com/project/apps-test/appdistribution/app/ios:com.example.myapp/releases/xyz'
}
end

before do
stub_const('Fastlane::Actions::SharedValues::FIREBASE_APP_DISTRO_RELEASE', :firebase_app_distro_release)
allow(Fastlane::Actions).to receive(:lane_context).and_return({ firebase_app_distro_release: firebase_release_info })
end

it 'uses the firebase icon' do
comment = run_described_fastlane_action(app_display_name: 'My App')
expect(comment).to include 'firebase.png'
end
end

context 'when using a Firebase download URL' do
it 'uses the firebase icon' do
comment = run_described_fastlane_action(
app_display_name: 'My App',
download_url: 'https://appdistribution.firebase.google.com/testerapps/1:123456:ios:abcdef/releases/xyz'
)
expect(comment).to include 'firebase.png'
end
end

context 'when using a non-Firebase download URL' do
it 'does not include any icon' do
comment = run_described_fastlane_action(base_params.merge(app_icon: nil))
expect(comment).not_to include 'firebase.png'
expect(comment).to match(/^<p>📲 You can test/)
end
end
end
end
end