Merge pull request #46 from adobe/staging

To Main : Release v3.0.0

.circleci/config.yml

@@ -12,93 +12,150 @@
 
 version: 2.1
 orbs:
-  android: circleci/[email protected]
+  android: circleci/[email protected]
+  codecov: codecov/[email protected]
 
 # Workflows orchestrate a set of jobs to be run;
 workflows:
   version: 2
   build-test-deploy:
     jobs:
-      - build-and-unit-test
-      - functional-test
+      - validate-code
+      - build-and-unit-test:
+          requires:
+            - validate-code
+      - functional-test:
+          requires:
+            - validate-code
+      - build-test-app:
+          requires:
+            - validate-code
+          filters:
+            branches:
+              only:
+                - main
+                - staging      
 
 jobs:
-  build-and-unit-test:
-    working_directory: ~/code
+  validate-code:
     executor:
-        name: android/android-machine
-        resource-class: large
-        tag: 2021.10.1
+      name: android/android-docker
+      resource-class: medium
+      tag: 2024.01.1
+
     steps:
       - checkout
+
+      - android/restore-gradle-cache
+
+      - android/restore-build-cache
+
       - run:
-          name: Checkstyle
-          command: make checkstyle
+          name: Check Format
+          command: make checkformat
 
       - run:
-          name: Javadoc
-          command: make ci-javadoc
+          name: Check Style
+          command: make checkstyle
+
+      - android/save-gradle-cache
+
+      - android/save-build-cache
+
       - store_artifacts:
-          path: ci/javadoc/build/reports
+          path: code/target/build/reports     
+  build-and-unit-test:
+    executor:
+      name: android/android-docker
+      resource-class: medium
+      tag: 2024.01.1
+
+    steps:
+      - checkout
 
-      - run:
-          name: Build
-          command: make ci-build
+      - android/restore-gradle-cache
+
+      - android/restore-build-cache
 
       - run:
-          name: UnitTests
-          command: make ci-unit-test
+          name: Javadoc
+          command: make javadoc
+
+      - store_artifacts:
+          path: code/target/build/docs/javadoc
 
-      # code coverage
       - run:
-          name: Upload Code Coverage Report
-          command: |
-            curl -s https://codecov.io/bash > codecov;
-            VERSION=$(grep 'VERSION=\"[0-9\.]*\"' codecov | cut -d'"' -f2);
-            for i in 1 256 512
-            do
-              shasum -a $i -c --ignore-missing <(curl -s "https://raw.githubusercontent.com/codecov/codecov-bash/${VERSION}/SHA${i}SUM") ||
-              shasum -a $i -c <(curl -s "https://raw.githubusercontent.com/codecov/codecov-bash/${VERSION}/SHA${i}SUM" | grep -w "codecov")
-            done
-            bash ./codecov -v -X s3 -c -D "./ci/unit-test/build/reports" -F unit-tests
+          name: Assemble Phone
+          command: make assemble-phone
+
+      - android/run-tests:
+          test-command: make unit-test-coverage
 
       - store_artifacts:
-          path: ci/unit-test/build/reports
+          path: code/target/build/reports/tests
 
       - store_test_results:
-          path: ci/unit-test/build/test-results
+          path: code/target/build/test-results/testPhoneDebugUnitTest
 
+      - android/save-gradle-cache
+
+      - android/save-build-cache
+
+      - codecov/upload:
+          file: code/target/build/reports/coverage/test/phone/debug/report.xml
+          flags: unit-tests
   functional-test:
-    executor:
+    executor: 
       name: android/android-machine
-      resource-class: large
-      tag: 2021.10.1
+      resource-class: medium
+      tag: 2024.01.1
+
     steps:
       - checkout
+
+      - android/restore-build-cache
+
+      - run:
+          name: List available emulator images
+          command: sdkmanager --list
+
       - android/start-emulator-and-run-tests:
           #   It should match the name seen in the "sdkmanager --list" output
           system-image: system-images;android-29;default;x86
           #   The command to be run, while waiting for emulator startup
-          post-emulator-launch-assemble-command: make ci-build
+          post-emulator-launch-assemble-command: make assemble-phone
           #   The test command
-          test-command: make ci-functional-test
-
-      # code coverage
-      - run:
-          name: Upload Code Coverage Report
-          command: |
-            curl -s https://codecov.io/bash > codecov;
-            VERSION=$(grep 'VERSION=\"[0-9\.]*\"' codecov | cut -d'"' -f2);
-            for i in 1 256 512
-            do
-              shasum -a $i -c --ignore-missing <(curl -s "https://raw.githubusercontent.com/codecov/codecov-bash/${VERSION}/SHA${i}SUM") ||
-              shasum -a $i -c <(curl -s "https://raw.githubusercontent.com/codecov/codecov-bash/${VERSION}/SHA${i}SUM" | grep -w "codecov")
-            done
-            bash ./codecov -v -X s3 -c -D "./ci/functional-test/build/reports" -F functional-tests
+          test-command: make functional-test-coverage
+
+      - android/save-build-cache
 
+      - codecov/upload:
+          file: code/target/build/reports/coverage/androidTest/phone/debug/connected/report.xml
+          flags: functional-tests
+
       - store_artifacts:
-          path: ci/functional-test/build/reports
+          path: code/target/build/reports/androidTests
 
       - store_test_results:
-          path: ci/functional-test/build/outputs/androidTest-results
+          path: code/target/build/outputs/androidTest-results
+
+  build-test-app:
+    executor:
+      name: android/android-docker
+      resource-class: medium
+      tag: 2024.01.1
+
+    steps:
+      - checkout
+
+      - android/restore-gradle-cache
+
+      - android/restore-build-cache
+
+      - run:
+          name: Assemble App
+          command: make assemble-app
+
+      - android/save-gradle-cache
 
+      - android/save-build-cache

.githooks/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+make format
+git diff --cached --name-only --diff-filter=d | while read filename; do git add "$filename"; done
+

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,82 @@
+#
+# Copyright 2024 Adobe. All rights reserved.
+# This file is licensed to you under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License. You may obtain a copy
+# of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under
+# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+# OF ANY KIND, either express or implied. See the License for the specific language
+# governing permissions and limitations under the License.
+#
+
+name: Bug report
+description: Create a bug report to help us improve. Use this template if you encountered an issue while integrating with or implementing the APIs of this SDK.
+labels: [bug, triage-required]
+
+body:
+- type: checkboxes
+  attributes:
+    label:  Prerequisites
+    description: Please check the following items before logging a new bug report.
+    options:
+    - label: This is not a Security Disclosure, otherwise please follow the guidelines in [Security Policy](https://github.com/adobe/aepsdk-target-android/security/policy).
+      required: true
+    - label: I have searched in this repository's issues to see if it has already been reported.
+      required: true
+    - label: I have updated to the latest released version of the SDK and the issue still persists.
+      required: true
+
+- type: textarea
+  attributes:
+    label: Bug summary
+    description: Please provide a summary of the bug you are reporting.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Environment
+    description: |
+      Please provide the OS version, SDK version(s) used, IDE version, and any other specific settings that could help us narrow down the problem.
+      Example:
+        - **OS**: Android 13
+        - **SDK(s)**: target 2.0.0, core 2.0.0
+        - **IDE**: Android Studio 2021.3.1 Patch 1
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Steps to reproduce
+    description: Steps to reproduce the behavior consistently.
+    placeholder: |
+      1. ...
+      2. ...
+      3. ...
+  validations:
+    required: false
+
+- type: textarea
+  attributes:
+    label: Current behavior
+    description: A concise description of what you are experiencing.
+  validations:
+    required: false
+
+- type: textarea
+  attributes:
+    label: Expected behavior
+    description: A concise description of what you expected to happen.
+  validations:
+    required: false
+
+- type: textarea
+  attributes:
+    label: Anything else?
+    description: |
+      Here you can include sample code that illustrates the problem, logs taken while reproducing the problem, or anything that can give us more context about the issue you are encountering.
+
+      Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+  validations:
+    required: false

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,55 @@
+#
+# Copyright 2024 Adobe. All rights reserved.
+# This file is licensed to you under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License. You may obtain a copy
+# of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under
+# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+# OF ANY KIND, either express or implied. See the License for the specific language
+# governing permissions and limitations under the License.
+#
+
+name: Feature request
+description: Suggest an idea for this project.
+labels: [feature-request, triage-required]
+
+body:
+- type: checkboxes
+  attributes:
+    label:  Prerequisites
+    description: Please check the following items before logging a new feature request.
+    options:
+    - label: This is not a Security Disclosure, otherwise please follow the guidelines in [Security Policy](https://github.com/adobe/aepsdk-target-android/security/policy).
+      required: true
+    - label: I have searched in this repository's issues to see if it has already been reported.
+      required: true
+
+- type: textarea
+  id: description
+  attributes:
+    label: Feature request summary
+    description: Please provide a summary of the feature.
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: Current behavior
+    description: A concise description of what you are experiencing.
+  validations:
+    required: false
+
+- type: textarea
+  attributes:
+    label: Expected behavior
+    description: A concise description of what you expected to happen.
+  validations:
+    required: false
+
+- type: textarea
+  attributes:
+    label: Additional implementation details or code snippets
+    description: Provide additional information about this request, implementation details or code snippets.
+  validations:
+    required: false

.github/ISSUE_TEMPLATE/project_epic.yml

@@ -0,0 +1,36 @@
+#
+# Copyright 2024 Adobe. All rights reserved.
+# This file is licensed to you under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License. You may obtain a copy
+# of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under
+# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+# OF ANY KIND, either express or implied. See the License for the specific language
+# governing permissions and limitations under the License.
+#
+
+name: Project epic
+description: Create an internal epic that represents the top level parent of multiple tasks.
+labels: [epic]
+
+body:
+- type: textarea
+  id: description
+  attributes:
+    label: Epic description
+    description: Please provide a detailed description for this epic.
+  validations:
+    required: true
+
+- type: textarea
+  id: tasks
+  attributes:
+    label: Tasks
+    description: |
+      Provide a high-level definition of done for this epic as a list of tasks that need to be completed.
+      Tip: List out the task links if they already exist or list them out as text with a descriptive title so they can be easily converted to task items.
+    placeholder: |
+      - [ ] your task link here
+  validations:
+    required: false