chore: adr in code and junit5 parameterized tests (WPB-10396) #3288

yamilmedina · 2024-08-06T08:13:07Z

WPB-10396 ADR revisited

PR Submission Checklist for internal contributors

The PR Title
- conforms to the style of semantic commits messages¹ supported in Wire's Github Workflow²
- contains a reference JIRA issue number like SQPIT-764
- answers the question: If merged, this PR will: ... ³
The PR Description
- is free of optional paragraphs and you have filled the relevant parts to the best of your ability

What's new in this PR?

Add ADRs
Add junit5 Parameterized tests, and its ADR at docs/adr/0003-introducing-junit5-parametrizable-tests.md

Issues

As part of the discussion in the last collective, this is the revamp ADRs effort, so we can have it in our review process and more important whenever we are including at least these 2 important categories:

Refactor that changes the way we do something or the software design (see. )
New library introduced, or replaced.

Causes (Optional)

New ADRs needs to be added under docs/adr folder.
The PR will be commented by the action if there is a new ADR document, to bring visibility to the reviewers.
When merged to develop, this will generate a web page with all the ADRs the project has: https://wireapp.github.io/wire-android

Attachments (Optional)

https://wireapp.github.io/wire-android/

PR Post Submission Checklist for internal contributors (Optional)

Wire's Github Workflow has automatically linked the PR to a JIRA issue

PR Post Merge Checklist for internal contributors

If any soft of configuration variable was introduced by this PR, it has been added to the relevant documents and the CI jobs have been updated.

References

https://sparkbox.com/foundry/semantic_commit_messages
https://github.com/wireapp/.github#usage
E.g. feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.

This reverts commit 6bcd8cf.

codecov-commenter · 2024-08-06T08:51:00Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 44.53%. Comparing base (9d2b37f) to head (58b4464).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #3288   +/-   ##
========================================
  Coverage    44.53%   44.53%           
========================================
  Files          453      453           
  Lines        15328    15328           
  Branches      2561     2561           
========================================
  Hits          6827     6827           
+ Misses        7784     7783    -1     
- Partials       717      718    +1

see 1 file with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9d2b37f...58b4464. Read the comment docs.

github-actions · 2024-08-06T09:11:01Z

Built wire-android-staging-compat-pr-3288.apk is available for download

AndroidBob · 2024-08-06T15:26:02Z

New ADR(s) in this PR 📚:

Decision record template by Michael Nygard

This is the template in Documenting architecture decisions - Michael Nygard.
You can use adr-tools for managing the ADR files.

In each ADR file, write these sections:

Title

Status

What is the status, such as proposed, accepted, rejected, deprecated, superseded, etc.?

Context

What is the issue that we're seeing that is motivating this decision or change?

Decision

What is the change that we're proposing and/or doing?

Consequences

What becomes easier or more difficult to do because of this change?

1. Record architecture decisions

Date: 2024-08-05

Status

Accepted

Context

We agreed in the past to use ADR's, but we lost track of it as we were using confluence to keep
them. This concern was raised in the last collective, and we need to decide how to proceed.

Decision

We will use Architecture Decision Records in the code and as part of the review process.
We will use the Lightway ADR template to keep the ADRs simple and
easy to maintain.

Consequences

We need to add a new folder to the repository, docs/adr, to keep the architecture decision
records.
Whenever a new refactoring or library is introduced, a new ADR should be created.
You can always request in the Pull request review process to add a new ADR, if you think it's
necessary.

2. Calling activity refactor

Date: 2024-08-01

Status

Accepted

Context

To support a second incoming call we need to refactor the code so we can handle the ongoing content
context, without losing the current context.

This is a retroactive decision record implemented
on #3264

Decision

Create 2 separate activities, one for the Incoming/Outgoing calls and another for the ongoing call.
In this way, we can keep the context of the ongoing call and handle the incoming/outgoing calls.

The design and interaction will look like this:

Consequences

StartingActivity will handle Incoming and Outgoing calls content, these contents are disposable
and can be recreated when receiving a new call.
OngoingCallActivity will handle the ongoing call content, this content is not disposable and
should be kept during the call.

3. Use parameterizable tests in JUnit5

Date: 2024-08-05

Status

Proposed

Context

Sometimes we need to write multiple tests for the same scenario, changing only the input values.

Decision

We will use parameterizable tests in JUnit5 to avoid writing multiple tests for the same scenario.

Consequences

Introduction of @ParameterizedTest annotation in the test class
and library.
The test method will receive the parameters as arguments.

yamilmedina · 2024-08-06T15:54:48Z

docs/adr/0003-introducing-junit5-parametrizable-tests.md

+
+## Status
+
+Proposed


TODO: Change to Accepted when PR approved

github-actions · 2024-08-06T16:26:15Z

Built wire-android-staging-compat-pr-3288.apk is available for download

github-actions · 2024-08-06T16:26:26Z

Built wire-android-dev-debug-pr-3288.apk is available for download

alexandreferris

Amazing! 😍 looking forward for it

alexandreferris · 2024-08-07T08:11:26Z

app/src/test/kotlin/com/wire/android/ui/userprofile/common/UsernameMapperTest.kt

+        enum class TestParams(val input: OtherUser, val expected: String) {
+            FEDERATED_USER(OTHER_USER.copy(userType = UserType.FEDERATED, handle = "handle"), "handle@domain"),
+            REGULAR_USER(OTHER_USER.copy(userType = UserType.GUEST, handle = "handle"), "handle"),
+            NO_HANDLE_USER(OTHER_USER.copy(userType = UserType.INTERNAL, handle = null), "")


github-actions · 2024-08-09T09:01:49Z

Built wire-android-staging-compat-pr-3288.apk is available for download

github-actions · 2024-08-09T09:02:02Z

Built wire-android-dev-debug-pr-3288.apk is available for download

sonarqubecloud · 2024-08-09T10:52:30Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

github-actions · 2024-08-09T11:29:57Z

Built wire-android-staging-compat-pr-3288.apk is available for download

github-actions · 2024-08-09T11:30:04Z

Built wire-android-dev-debug-pr-3288.apk is available for download

pull-request-size · 2024-08-09T14:23:15Z

Ups 🫰🟨

This PR is too big. Please try to break it up into smaller PRs.

vitorhugods

❤️

yamilmedina added 8 commits August 5, 2024 17:08

doc: add adr

994ed4f

doc: add lib param tests

ed91888

Merge branch 'develop' into chore/adr-and-tests

550146a

chore: add param tests

516a7f5

chore: add param tests

b0c5def

chore: add param tests

6bcd8cf

Revert "chore: add param tests"

19a7f70

This reverts commit 6bcd8cf.

chore: generate docs

2be9995

pull-request-size bot added the size/S label Aug 6, 2024

github-actions bot assigned yamilmedina Aug 6, 2024

yamilmedina added 2 commits August 6, 2024 10:18

chore: generate docs

dea2139

chore: manual cherrypick

ce89d5a

yamilmedina added 10 commits August 6, 2024 16:44

chore:action

8a57160

chore: adrstatus

6c3c607

chore: adrstatus, fix ref

e1c2654

chore: adrstatus, fix action

9efcfed

chore: adrstatus, fix action

5d99719

chore: adrstatus, fix action

55621b4

chore: adrstatus, fix action

0c617bd

chore: empty commit bump

7edaedb

chore: empty commit bump

9a347fb

chore: empty commit bump

bff9043

wireapp deleted a comment from github-actions bot Aug 6, 2024

yamilmedina changed the title ~~chore: adr in code and tests~~ chore: adr in code and tests (WPB-8645) Aug 6, 2024

echoes-hq bot added the echoes: throughput/ci-maintenance label Aug 6, 2024

yamilmedina changed the title ~~chore: adr in code and tests (WPB-8645)~~ chore: adr in code and tests (WPB-10396) Aug 6, 2024

Merge branch 'develop' into chore/adr-and-tests

9632b4a

yamilmedina commented Aug 6, 2024

View reviewed changes

alexandreferris approved these changes Aug 7, 2024

View reviewed changes

Merge branch 'develop' into chore/adr-and-tests

dfb29f6

Merge branch 'develop' into chore/adr-and-tests

58b4464

yamilmedina changed the base branch from develop to release/candidate August 9, 2024 14:22

pull-request-size bot added size/XL and removed size/S labels Aug 9, 2024

yamilmedina changed the base branch from release/candidate to develop August 9, 2024 14:23

pull-request-size bot added size/S and removed size/XL labels Aug 9, 2024

alexandreferris mentioned this pull request Aug 9, 2024

feat: Add Analytics Usage opt-in dialog (WPB-9970) & (WPB-9973) #3306

Merged

5 tasks

Garzas approved these changes Aug 12, 2024

View reviewed changes

vitorhugods approved these changes Aug 12, 2024

View reviewed changes

github-actions bot mentioned this pull request Aug 12, 2024

feat: Add Analytics Usage opt-in dialog (WPB-9970) & (WPB-9973) 🍒 #3310

Merged

5 tasks

MohamadJaara added this pull request to the merge queue Aug 13, 2024

Merged via the queue into develop with commit 5bd3261 Aug 13, 2024
18 checks passed

MohamadJaara deleted the chore/adr-and-tests branch August 13, 2024 11:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: adr in code and junit5 parameterized tests (WPB-10396) #3288

chore: adr in code and junit5 parameterized tests (WPB-10396) #3288

yamilmedina commented Aug 6, 2024 •

edited by github-actions bot

Loading

codecov-commenter commented Aug 6, 2024 •

edited

Loading

github-actions bot commented Aug 6, 2024

AndroidBob commented Aug 6, 2024 •

edited

Loading

yamilmedina Aug 6, 2024

github-actions bot commented Aug 6, 2024

github-actions bot commented Aug 6, 2024

alexandreferris left a comment

alexandreferris Aug 7, 2024

github-actions bot commented Aug 9, 2024

github-actions bot commented Aug 9, 2024

sonarqubecloud bot commented Aug 9, 2024

github-actions bot commented Aug 9, 2024

github-actions bot commented Aug 9, 2024

pull-request-size bot commented Aug 9, 2024

vitorhugods left a comment

chore: adr in code and junit5 parameterized tests (WPB-10396) #3288

chore: adr in code and junit5 parameterized tests (WPB-10396) #3288

Conversation

yamilmedina commented Aug 6, 2024 • edited by github-actions bot Loading

PR Submission Checklist for internal contributors

What's new in this PR?

Issues

Causes (Optional)

Attachments (Optional)

PR Post Submission Checklist for internal contributors (Optional)

PR Post Merge Checklist for internal contributors

References

codecov-commenter commented Aug 6, 2024 • edited Loading

Codecov Report

github-actions bot commented Aug 6, 2024

AndroidBob commented Aug 6, 2024 • edited Loading

New ADR(s) in this PR 📚:

Decision record template by Michael Nygard

Title

Status

Context

Decision

Consequences

1. Record architecture decisions

Status

Context

Decision

Consequences

2. Calling activity refactor

Status

Context

Decision

Consequences

3. Use parameterizable tests in JUnit5

Status

Context

Decision

Consequences

yamilmedina Aug 6, 2024

Choose a reason for hiding this comment

github-actions bot commented Aug 6, 2024

github-actions bot commented Aug 6, 2024

alexandreferris left a comment

Choose a reason for hiding this comment

alexandreferris Aug 7, 2024

Choose a reason for hiding this comment

github-actions bot commented Aug 9, 2024

github-actions bot commented Aug 9, 2024

sonarqubecloud bot commented Aug 9, 2024

Quality Gate passed

github-actions bot commented Aug 9, 2024

github-actions bot commented Aug 9, 2024

pull-request-size bot commented Aug 9, 2024

Ups 🫰🟨

vitorhugods left a comment

Choose a reason for hiding this comment

yamilmedina commented Aug 6, 2024 •

edited by github-actions bot

Loading

codecov-commenter commented Aug 6, 2024 •

edited

Loading

AndroidBob commented Aug 6, 2024 •

edited

Loading