feat(S-001): finalize Superformula test

.env_stage

@@ -0,0 +1 @@
+API_KEY="KC7Is6ZMmm9pJtce2CCzin4Np4GuCDraZ3M3Pdl6ibKfE96Byt4-RZ2p0c7qj_Dhg8g5BaMPfZ8uYfQ7OEXJoJzC85OULRmwXuaitDLQ5kqthjeFGhTxePA3gu3QZXYx"

.fvm/fvm_config.json

@@ -1,4 +1,4 @@
 {
-  "flutterSdkVersion": "3.13.9",
+  "flutterSdkVersion": "3.16.8",
   "flavors": {}
 }

.github/workflows/dart.yml

@@ -0,0 +1,20 @@
+name: PR Changes
+
+on:
+  pull_request:
+
+jobs:
+  run_tests:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: subosito/flutter-action@v2
+        with:
+          flutter-version: '3.13.9'
+      - run: dart pub global activate arb_utils
+      - run: flutter pub get
+      - run: flutter clean 
+      - run: make gen
+      - run: make l10n
+      - run: make tests-ci-cd
+

.gitignore

@@ -8,12 +8,15 @@
 .buildlog/
 .history
 .svn/
-
+# automated_tests related
+**/failures/
+**/coverage/
 # IntelliJ related
 *.iml
 *.ipr
 *.iws
 .idea/
+*.env
 
 # The .vscode folder contains launch configuration and tasks you configure in
 # VS Code which you may wish to be included in version control, so this line

.metadata

@@ -4,7 +4,27 @@
 # This file should be version controlled and should not be manually edited.
 
 version:
-  revision: ffb2ecea5223acdd139a5039be2f9c796962833d
-  channel: stable
+  revision: "d211f42860350d914a5ad8102f9ec32764dc6d06"
+  channel: "stable"
 
 project_type: app
+
+# Tracks metadata for the flutter migrate command
+migration:
+  platforms:
+    - platform: root
+      create_revision: d211f42860350d914a5ad8102f9ec32764dc6d06
+      base_revision: d211f42860350d914a5ad8102f9ec32764dc6d06
+    - platform: android
+      create_revision: d211f42860350d914a5ad8102f9ec32764dc6d06
+      base_revision: d211f42860350d914a5ad8102f9ec32764dc6d06
+
+  # User provided section
+
+  # List of Local paths (relative to this file) that should be
+  # ignored by the migrate tool.
+  #
+  # Files that are not part of the templates will be ignored by default.
+  unmanaged_files:
+    - 'lib/main.dart'
+    - 'ios/Runner.xcodeproj/project.pbxproj'

.vscode/launch.json

@@ -1,13 +1,32 @@
 {
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
         {
-            "name": "app",
+            "name": "Smoke Test (prod)",
             "request": "launch",
-            "type": "dart"
+            "type": "dart",
+            "program": "integration_test/app_test.dart",
+            "args": [
+                "--dart-define=app.flavor=prod"
+            ]
+        },
+        {
+            "name": "RestauranTour (stage)",
+            "request": "launch",
+            "type": "dart",
+            "program": "lib/main.dart",
+            "args": [
+                "--dart-define=app.flavor=stage"
+            ]
+        },
+        {
+            "name": "RestauranTour (prod)",
+            "request": "launch",
+            "type": "dart",
+            "program": "lib/main.dart",
+            "args": [
+                "--dart-define=app.flavor=prod"
+            ]
         }
     ]
 }

.vscode/settings.json

@@ -1,5 +1,5 @@
 {
-    "dart.flutterSdkPath": ".fvm/flutter_sdk",
+    "dart.flutterSdkPath": "~/fvm/versions/3.13.9",
     "search.exclude": {
         "**/.fvm": true
     },

Makefile

@@ -0,0 +1,73 @@
+# SETUP:
+get :
+	flutter pub get
+
+setup-fvm-version :
+	fvm install 3.16.8 && \
+	fvm global 3.16.8
+
+pre-setup :
+	flutter clean &&\
+	dart run build_runner clean && \
+	dart pub global activate arb_utils && \
+	dart pub global activate flutter_gen
+
+
+setup-env-file :
+	test -f .env || echo "API_KEY=''" >> .env
+
+setup : pre-setup get l10n gen asset-gen setup-env-file unit-tests
+
+
+fix-gen :
+	mkdir -p .dart_tool/flutter_gen/ && echo "name: stub" > .dart_tool/flutter_gen/pubspec.yaml
+
+try-fix-gen : fix-gen
+	dart run build_runner build --delete-conflicting-outputs
+
+# TESTS:
+
+tests : 
+	flutter test --coverage
+
+all-tests : tests integration-tests
+
+unit-tests : 
+	flutter test -x golden --coverage
+
+golden-tests :
+	flutter test -t golden --coverage
+
+tests-ci-cd : 
+	rm -rf coverage && flutter test --coverage --dart-define=runningOnCICD=true
+
+integration-tests : 
+	flutter test integration_test/app_test.dart
+
+update-goldens : remove-goldens-failures
+	flutter test --update-goldens
+
+remove-goldens-failures : 
+	rm test/golden_test/failures/*
+
+# TEST COVERAGE
+
+show-coverage : tests lcov
+
+lcov-ignore : 
+	lcov --remove coverage/lcov.info 'lib/core/*' 'lib/theme/*' 'lib/models/*.g.dart' -o coverage/lcov.info
+
+lcov : tests lcov-ignore
+	genhtml -q -o coverage coverage/lcov.info && open coverage/index.html
+
+
+# CODE GENERATION
+
+l10n :
+	flutter gen-l10n && arb_utils sort lib/l10n/app_en.arb 
+
+asset-gen :
+	fluttergen
+
+gen :
+	dart run build_runner build --delete-conflicting-outputs || make try-fix-gen

README.md

@@ -1,38 +1,113 @@
 # RestauranTour
 
-Be sure to read **all** of this document carefully, and follow the guidelines within.
 
-## Vendorized Flutter
+## Welcom to RestauranTour!
 
-3. We use [fvm](https://fvm.app/) for managing the flutter version within the project. Using terminal, while being on the test repository, install the tools dependencies by running the following commands:
+The idea of this project is to help you to choose the best restaurants!
 
-    ```sh
-    dart pub global activate fvm
-    ```
+### Some features:
+- Navigate through the available restaurants and see basic information like `opened status`, `price` and `classification` from other users directly from the list.
+- See details of the restaurant, when you open a restaurant the details page will show you more information like `review` from users.
+- Save the best! On the details screen you can add to favorites those restaurant make you heartbeat!
+- Favorite list shows all the restaurant that you love.  
 
-    The output of the command will ask to add the folder `./pub-cache/bin` to your PATH variables, if you didn't already. If that is the case, add it to your environment variables, and restart the terminal.
+## Setup:
 
-    ```sh
-    export PATH="$PATH":"$HOME/.pub-cache/bin" # Add this to your environment variables
-    ```
 
-4. Install the project's flutter version using `fvm`.
+To make things easier, we are using Makefile to manage the commands and setup you project.
 
-    ```sh
-    fvm use
-    ```
+Before start with Make commands, make sure that you have installed the fvm in your system, see [Vendorized Flutter](#vendorized-flutter) before.
 
-5. From now on, you will run all the flutter commands with the `fvm` prefix. Get all the projects dependencies.
+#### 1 - make setup-fvm-version 
 
-    ```sh
-    fvm flutter pub get
-    ```
+Now that you have installed the fvm, by running the command `fvm --version` this should return the fvm version installed in your system like this:
+ ```
+$ fvm --version
+2.4.1
+```
+Now we can proceed, well as mentioned before, we will use make for make things for us. To setup the fvm version run the following command:
 
-More information on the approach can be found here:
+``` bash
+make setup-fvm-version
+```
+The curremt version of Flutter is `3.16.8` but don't worry about setup this, `make setup-fvm-version` will do it automatically.
 
-> hhttps://fvm.app/docs/getting_started/installation
+> Make setup-fvm-version will run the following commands: `fvm install 3.16.8` and `fvm global 3.16.8`
+
+This will download the version that we are using on the project, and setup as global.
+
+### 2 - make setup
+
+This will setup all things that we need work on the project.
+To make sure that everything is working well, `make setup` will run some commands:
+
+Pre-setup:
+
+- `flutter clean` # clean the flutter project
+-	`dart run build_runner clean` # clean the build runner
+- `dart pub global activate arb_utils` # activate the arb_utils package to generate locales
+-	`dart pub global activate flutter_gen` # activate the flutter_gen package for management assets
+
+Setup:
+- `get` # flutter pub get
+- `l10n` # generate the locales and sort
+- `gen` # generate the models
+- `asset-gen` # generate the assets
+- `setup-env-file` # generate the `.env` file
+- `unit-tests` # run unit tests to ensure everything is working
+
+<details>
+<summary>All make commands available</summary>
 
-From the root directory:
+<ul>
+<details>
+<summary>Setup</summary>
+
+<ul><b>get</b> <i># run flutter pub get</i></ul>
+<ul><b>setup-fvm-version</b> <i># download and setup the fvm flutter version for the project</i></ul>
+<ul><b>pre-setup</b> <i># clean the project and install some dependencies</i></ul>
+<ul><b>setup-env-file</b> <i># generate the .env file</i></ul>
+<ul><b>setup</b> <i># run pre-setup, setup-env-file, run code generation and run unit tests</i></ul>
+<ul><b>try-fix-gen</b> <i># try run code generation if fail try fix and run code generation again</i></ul>
+<ul><b>fix-gen</b> <i># perform some steps to fix code generation</i></ul>
+
+</details>
+</ul>
+
+<ul>
+<details>
+<summary>Tests</summary>
+<ul><b>tests</b> <i># run unit and golden tests</i></ul>
+<ul><b>all-tests</b> <i># run all type of tests on project, unit, golden and integration</i></ul>
+<ul><b>unit-tests</b> <i># run only unit tests</i></ul>
+<ul><b>tests-ci-cd</b> <i>#run tests with a flag that enable threshold for golden tests on pipeline</i></ul>
+<ul><b>integration-tests</b> <i># run integration test</i></ul>
+<ul><b>update-goldens</b> <i># update the golden images</i></ul>
+<ul><b>remove-goldens-failures</b> <i># this remove the failure folder of golden tests</i></ul>
+</details>
+</ul>
+
+<ul>
+<details>
+<summary>Coverage</summary>
+See <a href="#coverage-reports---lcov">Coverage reports</a>
+
+<ul><b>lcov</b> <i># run the tests and show the coverage report filtered</i></ul>
+<ul><b>show-coverage</b> <i># run tests and show the coverage report</i></ul>
+<ul><b>lcov-ignore</b> <i># remove some files from coverage report</i></ul>
+</details>
+</ul>
+
+<ul>
+<details>
+<summary>Code gen</summary>
+<ul><b>l10n</b> <i># generate the localization files</i></ul>
+<ul><b>asset-gen</b> <i># generate the assets file</i></ul>
+<ul><b>gen</b> <i># generate models using build_runner</i></ul>
+</details>
+</ul>
+
+</details>
 
 
 ### IDE Setup
@@ -181,3 +256,51 @@ Just create a new issue in this repo and we will respond and get back to you qui
 ## Review
 
 The coding challenge is a take-home test upon which we'll be conducting a thorough code review once complete. The review will consist of meeting some more of our mobile engineers and giving a review of the solution you have designed. Please be prepared to share your screen and run/demo the application to the group. During this process, the engineers will be asking questions.
+
+
+## Vendorized Flutter
+
+We use [fvm](https://fvm.app/) for managing the flutter version within the project. Using terminal, while being on the test repository, install the tools dependencies by running the following commands:
+
+```sh
+    dart pub global activate fvm
+```
+
+The output of the command will ask to add the folder `./pub-cache/bin` to your PATH variables, if you didn't already. If that is the case, add it to your environment variables, and restart the terminal.
+
+```sh
+export PATH="$PATH":"$HOME/.pub-cache/bin" # Add this to your environment variables
+```
+
+
+
+More information on the approach can be found here:
+
+> hhttps://fvm.app/docs/getting_started/installation
+
+[Back to setup](#setup)
+
+## Coverage reports - lcov
+LCOV is an extension of GCOV, a GNU tool which provides information about
+what parts of a program are actually executed (i.e. "covered") while running
+a particular test case. The extension consists of a set of Perl scripts
+which build on the textual GCOV output to implement the following enhanced
+functionality:
+
+- HTML based output: coverage rates are additionally indicated using bar
+graphs and specific colors.
+
+- Support for large projects: overview pages allow quick browsing of
+coverage data by providing three levels of detail: directory view,
+file view and source code view.
+
+LCOV was initially designed to support Linux kernel coverage measurements,
+but works as well for coverage measurements on standard user space
+applications.
+
+<a href="https://formulae.brew.sh/formula/lcov">Install on Linux/MacOs using brew</a>
+
+<a href="https://community.chocolatey.org/packages/lcov?source=post_page-----7c58dda07080--------------------------------">Install on Windows</a>
+
+
+[Back to make](#2---make-setup)

analysis_options.yaml

@@ -9,5 +9,4 @@ linter:
   rules:
     ## The following rules are excluded only to keep compatibility with our previous lint set (pedantic).
     ## There's room to discuss them individually and raise PRs adjusting our codebase.
-    avoid_print: false
     require_trailing_commas: true