setting up FenixFramework (closes #115) (#135)

* setting up FenixFramework

* update .gitignore

* rename local.dev.yml

* re-add example files

* adding password example

.gitignore

@@ -7,4 +7,5 @@ infer-out
 *.iml
 .idea
 .DS_Store
-fenix-framework.properties
+fenix-framework.properties
+local.dev.yml

README.md

@@ -16,3 +16,28 @@ To see the coverage reports, go to <module name>/target/site/jacoco/index.html.
 
 - **Group 1:**
 - **Group 2:**
+
+### Infrastructure
+
+This project includes the persistent layer, as offered by the FénixFramework.
+This part of the project requires to create databases in mysql as defined in `resources/fenix-framework.properties` of each module.
+
+See the lab about the FénixFramework for further details.
+
+#### Docker (Alternative to installing Mysql in your machine)
+
+To use a containerized version of mysql, follow these stesp:
+
+```
+docker-compose -f local.dev.yml up -d
+docker exec -it mysql sh
+```
+
+Once logged into the container, enter the mysql interactive console
+
+```
+mysql --password
+```
+
+And create the 5 databases for the project as specified in
+the `resources/fenix-framework.properties`.

activity/src/main/resources/fenix-framework.properties.example

@@ -1,7 +1,7 @@
-# Copy this file to fenix-framework.properties 
+# Copy this file to fenix-framework.properties
 # and replace password by your mysql root password
 dbAlias=//localhost:3306/adventures
 dbUsername=root
 dbPassword=password
 updateRepositoryStructureIfNeeded=true
-canCreateDomainMetaObjects=false
+canCreateDomainMetaObjects=false

bank/src/main/resources/fenix-framework.properties.example

@@ -1,7 +1,7 @@
-# Copy this file to fenix-framework.properties 
+# Copy this file to fenix-framework.properties
 # and replace password by your mysql root password
 dbAlias=//localhost:3306/adventures
 dbUsername=root
 dbPassword=password
 updateRepositoryStructureIfNeeded=true
-canCreateDomainMetaObjects=false
+canCreateDomainMetaObjects=false

broker/src/main/resources/fenix-framework.properties.example

@@ -1,7 +1,7 @@
-# Copy this file to fenix-framework.properties 
+# Copy this file to fenix-framework.properties
 # and replace password by your mysql root password
 dbAlias=//localhost:3306/adventures
 dbUsername=root
 dbPassword=password
 updateRepositoryStructureIfNeeded=true
-canCreateDomainMetaObjects=false
+canCreateDomainMetaObjects=false

car/src/main/resources/fenix-framework.properties.example

@@ -0,0 +1,7 @@
+# Copy this file to fenix-framework.properties
+# and replace password by your mysql root password
+dbAlias=//localhost:3306/adventures
+dbUsername=root
+dbPassword=password
+updateRepositoryStructureIfNeeded=true
+canCreateDomainMetaObjects=false

hotel/src/main/resources/fenix-framework.properties.example

@@ -1,7 +1,7 @@
-# Copy this file to fenix-framework.properties 
+# Copy this file to fenix-framework.properties
 # and replace password by your mysql root password
 dbAlias=//localhost:3306/adventures
 dbUsername=root
 dbPassword=password
 updateRepositoryStructureIfNeeded=true
-canCreateDomainMetaObjects=false
+canCreateDomainMetaObjects=false

local.dev.yml.example

@@ -0,0 +1,14 @@
+version: '2'
+services:
+  mysql:
+    image: mysql
+    container_name: mysql
+    ports:
+      - "3306:3306"
+    volumes: 
+      - .:/code
+    environment:
+      - MYSQL_USER=root
+      - MYSQL_ROOT_PASSWORD=password
+      - MYSQL_ALLOW_EMPTY_PASSWORD='yes'
+      - MYSQL_DATABASE=adventures

tax/src/main/resources/fenix-framework.properties.example

@@ -0,0 +1,7 @@
+# Copy this file to fenix-framework.properties
+# and replace password by your mysql root password
+dbAlias=//localhost:3306/adventures
+dbUsername=root
+dbPassword=password
+updateRepositoryStructureIfNeeded=true
+canCreateDomainMetaObjects=false