Skip to content

Commit a7d93cf

Browse files
WavesonicsWavesonics
committed
Merge branch 'main' into l10n_main
# Conflicts: # app/src/main/res/values-zh-rCN/strings.xml
2 parents b12bb8a + eeafadb commit a7d93cf

116 files changed

Lines changed: 3916 additions & 2434 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/README.md‎

Lines changed: 2 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# GitHub Actions Workflows for App Publishing
22

3-
This directory contains GitHub Actions workflow configurations for automating the build and deployment process of the
4-
Secure Camera app to both Google Play and GitHub Releases.
3+
This directory contains GitHub Actions workflow configurations for automating the build and
4+
deployment process to both Google Play and GitHub Releases.
55

66
## Workflow: Publish Releases
77

@@ -11,25 +11,6 @@ the format `v*` (e.g., `v1.0.0`) is pushed to the repository. It contains two jo
1111
1. Build and publish to Play Store
1212
2. Build and publish GitHub release
1313

14-
### Play Store Job Steps
15-
16-
1. Checkout the code
17-
2. Set up JDK 17
18-
3. Set up Ruby and install Fastlane
19-
4. Decode the Android keystore from a base64-encoded secret
20-
5. Build the release AAB with proper signing
21-
6. Decode the Google Play service account key
22-
7. Deploy to Google Play using Fastlane
23-
24-
### GitHub Release Job Steps
25-
26-
1. Checkout the code
27-
2. Set up JDK 17
28-
3. Decode a separate Android keystore from a base64-encoded secret
29-
4. Build a signed release APK
30-
5. Create a GitHub release
31-
6. Attach the APK to the release
32-
3314
### Required Secrets
3415

3516
#### For Play Store Publishing
@@ -67,39 +48,3 @@ The following secrets must be configured in your GitHub repository settings:
6748
3. **GITHUB_RELEASE_KEY_ALIAS**: Alias of the key in the GitHub release keystore
6849

6950
4. **GITHUB_RELEASE_KEY_PASSWORD**: Password for the key in the GitHub release keystore
70-
71-
### How to Use
72-
73-
1. Set up all the required secrets in your GitHub repository settings:
74-
- For Play Store publishing: ENCODED_KEYSTORE, KEYSTORE_PASSWORD, KEY_ALIAS, KEY_PASSWORD, PLAY_STORE_CONFIG_JSON
75-
- For GitHub release publishing: GITHUB_RELEASE_ENCODED_KEYSTORE, GITHUB_RELEASE_KEYSTORE_PASSWORD,
76-
GITHUB_RELEASE_KEY_ALIAS, GITHUB_RELEASE_KEY_PASSWORD
77-
2. When you're ready to release a new version:
78-
- Update the version information in `gradle/libs.versions.toml`
79-
- Commit and push the changes
80-
- Create and push a new tag with the format `v1.0.0` (matching your version)
81-
```bash
82-
git tag v1.0.0
83-
git push origin v1.0.0
84-
```
85-
3. The workflow will automatically trigger and:
86-
- Deploy the app to Google Play
87-
- Create a GitHub release with the signed APK attached
88-
89-
### Troubleshooting
90-
91-
If the workflow fails, check the following:
92-
93-
#### For Play Store Publishing
94-
95-
1. Ensure all Play Store secrets are correctly configured
96-
2. Verify that the keystore is valid and contains the correct key
97-
3. Make sure the Google Play service account has the necessary permissions
98-
4. Check that the app's version code has been incremented since the last release
99-
100-
#### For GitHub Release Publishing
101-
102-
1. Ensure all GitHub release secrets are correctly configured
103-
2. Verify that the GitHub release keystore is valid and contains the correct key
104-
3. Check that you have the necessary permissions to create releases in the repository
105-
4. Verify that the APK is being built correctly

‎.github/workflows/build.yml‎

Lines changed: 72 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,23 @@ on:
77
branches: [ "**" ]
88

99
jobs:
10-
build:
10+
build-and-unit-tests:
1111
runs-on: ubuntu-latest
12-
strategy:
13-
matrix:
14-
api-level: [ 34 ]
15-
1612
steps:
17-
- uses: actions/checkout@v4
13+
- uses: actions/checkout@v5
1814

1915
- name: Set up JDK
20-
uses: actions/setup-java@v4
16+
uses: actions/setup-java@v5
2117
with:
2218
distribution: 'temurin'
2319
java-version: '17'
2420

2521
- name: Setup Gradle
2622
uses: gradle/actions/setup-gradle@v4
2723

24+
- name: Gradle cache
25+
uses: gradle/actions/setup-gradle@v4
26+
2827
- name: Grant execute permission for gradlew
2928
run: chmod +x gradlew
3029

@@ -37,49 +36,69 @@ jobs:
3736
- name: Run Unit Tests
3837
run: ./gradlew test
3938

40-
# - name: Enable KVM
41-
# run: |
42-
# echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
43-
# sudo udevadm control --reload-rules
44-
# sudo udevadm trigger --name-match=kvm
45-
#
46-
# - name: AVD cache
47-
# uses: actions/cache@v4
48-
# id: avd-cache
49-
# with:
50-
# path: |
51-
# ~/.android/avd/*
52-
# ~/.android/adb*
53-
# key: avd-${{ matrix.api-level }}
54-
#
55-
# - name: create AVD and generate snapshot for caching
56-
# if: steps.avd-cache.outputs.cache-hit != 'true'
57-
# uses: reactivecircus/android-emulator-runner@v2
58-
# with:
59-
# api-level: ${{ matrix.api-level }}
60-
# arch: x86_64
61-
# target: default
62-
# force-avd-creation: false
63-
# disable-animations: false
64-
# script: echo "Generated AVD snapshot for caching."
65-
#
66-
# - name: Run Instrumentation Tests
67-
# uses: reactivecircus/android-emulator-runner@v2
68-
# with:
69-
# api-level: ${{ matrix.api-level }}
70-
# arch: x86_64
71-
# target: default
72-
# force-avd-creation: false
73-
# emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-front emulated -camera-back emulated
74-
# disable-animations: true
75-
# script: |
76-
# adb wait-for-device
77-
# adb shell input keyevent 82
78-
# ./gradlew connectedOssDebugAndroidTest --continue
79-
80-
- name: Upload Test Reports
81-
if: failure()
82-
uses: actions/upload-artifact@v4
83-
with:
84-
name: android-test-report
85-
path: '**/build/reports/'
39+
# instrumentation-tests:
40+
# needs: build-and-unit-tests
41+
# runs-on: ubuntu-latest
42+
# strategy:
43+
# matrix:
44+
# api-level: [ 29, 33, 36 ]
45+
# image-target: [ google_apis ]
46+
# steps:
47+
# - uses: actions/checkout@v5
48+
#
49+
# - name: Set up JDK
50+
# uses: actions/setup-java@v5
51+
# with:
52+
# distribution: 'temurin'
53+
# java-version: '17'
54+
#
55+
# - name: Setup Gradle
56+
# uses: gradle/actions/setup-gradle@v4
57+
#
58+
# - name: Grant execute permission for gradlew
59+
# run: chmod +x gradlew
60+
#
61+
# - name: Enable KVM
62+
# run: |
63+
# echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
64+
# sudo udevadm control --reload-rules
65+
# sudo udevadm trigger --name-match=kvm
66+
#
67+
# - name: AVD cache
68+
# uses: actions/cache@v4
69+
# id: avd-cache
70+
# with:
71+
# path: |
72+
# ~/.android/avd/*
73+
# ~/.android/adb*
74+
# key: avd-${{ matrix.api-level }}-{{ matrix.image-target }}
75+
#
76+
# - name: create AVD and generate snapshot for caching
77+
# if: steps.avd-cache.outputs.cache-hit != 'true'
78+
# uses: reactivecircus/android-emulator-runner@v2
79+
# with:
80+
# api-level: ${{ matrix.api-level }}
81+
# target: ${{ matrix.image-target }}
82+
# arch: x86_64
83+
# force-avd-creation: false
84+
# emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim
85+
# disable-animations: false
86+
# script: echo "Generated AVD snapshot for caching."
87+
#
88+
# - name: Run Instrumentation Tests
89+
# uses: reactivecircus/android-emulator-runner@v2
90+
# with:
91+
# api-level: ${{ matrix.api-level }}
92+
# target: ${{ matrix.image-target }}
93+
# force-avd-creation: false
94+
# emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim
95+
# disable-animations: true
96+
# arch: x86_64
97+
# script: ./gradlew connectedCheck
98+
#
99+
# - name: Upload Test Reports
100+
# if: failure()
101+
# uses: actions/upload-artifact@v4
102+
# with:
103+
# name: android-test-report
104+
# path: '**/build/reports/'

‎.github/workflows/publish-release.yml‎

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ jobs:
1414

1515
steps:
1616
- name: Checkout code
17-
uses: actions/checkout@v4
17+
uses: actions/checkout@v5
1818

1919
- name: Set up JDK
20-
uses: actions/setup-java@v4
20+
uses: actions/setup-java@v5
2121
with:
2222
distribution: 'temurin'
2323
java-version: '17'
@@ -37,6 +37,32 @@ jobs:
3737
- name: Run Unit Tests
3838
run: ./gradlew test
3939

40+
- name: Enable KVM
41+
run: |
42+
echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
43+
sudo udevadm control --reload-rules
44+
sudo udevadm trigger --name-match=kvm
45+
46+
- name: AVD cache
47+
uses: actions/cache@v4
48+
id: avd-cache
49+
with:
50+
path: |
51+
~/.android/avd/*
52+
~/.android/adb*
53+
key: avd-33-google_apis
54+
55+
# - name: Run Instrumentation Tests
56+
# uses: reactivecircus/android-emulator-runner@v2
57+
# with:
58+
# api-level: 33
59+
# target: google_apis
60+
# force-avd-creation: false
61+
# emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
62+
# disable-animations: true
63+
# arch: x86_64
64+
# script: ./gradlew connectedCheck
65+
4066
- name: Build Signed Full Release APK
4167
env:
4268
KEYSTORE_FILE: gh-release-keystore.jks
@@ -78,10 +104,10 @@ jobs:
78104

79105
steps:
80106
- name: Checkout code
81-
uses: actions/checkout@v4
107+
uses: actions/checkout@v5
82108

83109
- name: Set up JDK
84-
uses: actions/setup-java@v4
110+
uses: actions/setup-java@v5
85111
with:
86112
distribution: 'temurin'
87113
java-version: '17'

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,4 @@
1515
local.properties
1616
.idea
1717
app/release
18+
htmlReport/

‎.junie/guidelines.md‎

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,53 @@ blurring.
1818
* We use tabs, no spaces
1919
* We should write unit tests when possible for new functions or features
2020
* We use Mockk for our test mocking
21-
* Comment code only sparingly. Obvious comments should be left out, only comment on code that is slight weird or complex
21+
* Comment code only sparingly. Obvious comments should be left out, only comment on code that is slight weird or complex
22+
23+
## Data Architecture
24+
25+
We use a simple, layered architecture:
26+
27+
- **DataSource**
28+
- Stateless
29+
- Lowest-level components that talk to the outside world (Android framework, storage, camera, crypto, file
30+
provider).
31+
- Responsibilities: raw I/O only, no business rules. Example: read/write bytes via EncryptedFile, capture image
32+
bytes via CameraX, access secure app-private directories, provide streams for sharing via a FileProvider.
33+
- Should not expose Android-specific types to upper layers when avoidable; return plain data (bytes, DTOs) or flows.
34+
35+
- **Repository**
36+
- Stateful
37+
- Single source of truth for a data domain. Orchestrates one or more DataSources and enforces privacy rules.
38+
- Responsibilities: enforce stripping of EXIF/metadata before persisting; ensure data at rest is encrypted and only
39+
stored in app-private storage; map raw data to domain models; cache as needed; expose cold/suspend functions and
40+
Flow/StateFlow for observation.
41+
- Example: PhotoRepository saves a captured image by invoking Camera DataSource, strips metadata, writes encrypted
42+
bytes, indexes result for the gallery, and provides a shareable URI when requested.
43+
44+
- **UseCase**
45+
- Stateless
46+
- Focused application actions that compose repository operations into a single intention.
47+
- Responsibilities: encapsulate business logic and validation, thread policy (suspend/invoke pattern), and error
48+
mapping. Keep them platform-agnostic where possible.
49+
- Examples: CapturePhotoUseCase, GetGalleryItemsUseCase, DeletePhotoUseCase, SharePhotoUseCase,
50+
SetOrVerifyPinUseCase.
51+
52+
- **ViewModel**
53+
- Stateful
54+
- UI-facing state holder for Compose screens/tabs. Consumes UseCases and exposes UI state/events (StateFlow,
55+
immutable state objects).
56+
- Responsibilities: transform domain results to UI models, handle one-off effects (navigation/events), survive
57+
config changes, and never leak sensitive data beyond what the UI needs.
58+
- Example: GalleryViewModel collects gallery flow, requests SharePhotoUseCase when the user shares, and gates access
59+
behind the PIN.
60+
61+
### Conventions:
62+
63+
- Keep DataSources minimal and framework-bound; keep Repositories the place for privacy enforcement; keep UseCases small
64+
and composable; keep ViewModels UI-only.
65+
- Prefer KMP-friendly abstractions where sensible (domain models, use cases), while Android-specific details live in
66+
DataSources and DI wiring.
67+
- Write unit tests for UseCases and Repositories; mock DataSources with Mockk, or implement a dummy of the interface.
68+
Write UI/state tests around ViewModels when logic is non-trivial.
69+
- Entities in a given layer should not access siblings of the same layer when ever possible, they should only access
70+
entities in the layer below them.

0 commit comments

Comments
 (0)