Fix tests:

* Since the acceptance and unit test from different bounded context run in parallel, I had to split the acceptance ones in a different database
* Move the docker things to the root directory in order to follow the same convention as with other DDD example repos
* Update MySQL container image version and connector library in order to avoid SSL errors (not acomplished, so disabled SSL. It's due to an error with JVM >= 11)
* Rename project from Scala HTTP API to CQRS DDD Scala Example in the `README.md` and other points such as the container names and application JAR
* Fix run command trying to run a non existing `Launcher` class (it was named after `Starter`, now it's renamed)
* Fix backoffice consumers application launching

Author: JavierCane

.env.dist

@@ -0,0 +1,15 @@
+# Define here your desired values for each variable
+# and copy this `.env.dist` file to this very same directory with the `.env` name
+# in order to be used by the `docker-compose.yml`
+
+# MySQL container variables
+MYSQL_HOST=codelytv-cqrs_ddd_scala_example-mysql
+MYSQL_PORT=3306
+MYSQL_ROOT_PASSWORD=c0d3ly
+MYSQL_DATABASE=cqrs_ddd_scala_example
+
+PHP_IDE_CONFIG=serverName=CodelyTvCqrsDddScalaExample
+
+# RabbitMQ container variables
+RABBITMQ_DEFAULT_USER=codelytv
+RABBITMQ_DEFAULT_PASS=c0d3ly

.gitignore

@@ -14,7 +14,7 @@ src/*/target
 app/target
 
 # Environment variables file intended for customize the Docker containers parameters letting each developer has its own values.
-docker/.env
+.env
 
 # Application log file and compressed previous logs (see conf/logback.xml)
 var/log/app_log.json

.travis.yml

@@ -21,10 +21,8 @@ cache:
     - $HOME/.sbt/boot/
 
 before_install:
-  - cd docker/
   - cp .env.dist .env
   - docker-compose up -d
-  - cd ..
   - sbt "shared/createDbTables"
 
 script:

README.md

@@ -44,7 +44,7 @@ One of the goals of this project is to serve as an example for the [course on Sc
 | JSON marshalling          | [Spray JSON](https://github.com/spray/spray-json)           | [User](src/main/tv/codely/scala_http_api/module/user/infrastructure/marshaller/UserJsonFormatMarshaller.scala) & [User attributes](src/main/tv/codely/scala_http_api/module/user/infrastructure/marshaller/UserNameJsonFormatMarshaller.scala) marshallers |
 | Database integration      | [Doobie](http://tpolecat.github.io/doobie/)                 | [Video repository](src/main/tv/codely/scala_http_api/module/video/infrastructure/repository/DoobieMySqlVideoRepository.scala) & [its corresponding integration test](src/test/tv/codely/scala_http_api/module/video/infrastructure/repository/DoobieMySqlVideoRepositoryShould.scala) |
 | Domain events publishing  | [Akka RabbitMQ](https://github.com/NewMotion/akka-rabbitmq) | [Publisher implementation](src/main/tv/codely/scala_http_api/module/shared/infrastructure/message_broker/rabbitmq/RabbitMqMessagePublisher.scala) & [its corresponding integration test](src/test/tv/codely/scala_http_api/module/shared/infrastructure/message_broker/rabbitmq/RabbitMqMessagePublisherShould.scala) |
-| Infrastructure management | [Docker](https://www.docker.com/)                           | [Docker Compose definition](docker/docker-compose.yml) |
+| Infrastructure management | [Docker](https://www.docker.com/)                           | [Docker Compose definition](docker-compose.yml) |
 | Logging                   | [ScalaLogging](https://github.com/typesafehub/scala-logging)<br> + [Logback](https://logback.qos.ch/)<br> + [Logstash encoder](https://github.com/logstash/logstash-logback-encoder) | [Logback configuration](conf/logback.xml), [logger implementation](src/main/tv/codely/scala_http_api/module/shared/infrastructure/logger/scala_logging/ScalaLoggingLogger.scala) & [its corresponding integration test](src/test/tv/codely/scala_http_api/module/shared/infrastructure/logger/scala_logging/ScalaLoggingLoggerShould.scala) |
 | Command line command      | [Scopt](https://github.com/scopt/scopt)                     | [Database tables creation script](src/main/tv/codely/scala_http_api/entry_point/cli/DbTablesCreator.scala) |
 | Distribution/deploy       | [SBT Native packager](http://sbt-native-packager.readthedocs.io/en/latest/) | [Build & deploy instructions](#Deploy) |
@@ -57,23 +57,29 @@ One of the goals of this project is to serve as an example for the [course on Sc
 ## Environment setup
 
 ### Install the needed tools
-1. Clone this repository: `git clone https://github.com/CodelyTV/scala-http-api.git scala-http-api`
+1. Clone this repository: `git clone https://github.com/CodelyTV/cqrs-ddd-scala-example.git cqrs-ddd-scala-example`
 2. Download and install [Docker compose](https://docs.docker.com/compose/install/). We'll need it in order to run all the project infrastructure.
 3. Download and install [SBT](http://www.scala-sbt.org/download.html)
 
 ### Prepare the application environment
-1. Copy [the Docker environment variables config file](docker/.env.dist) and tune it with your desired values: `cp docker/.env.dist docker/.env`
-2. Start Docker and bring up the project needed containers: `cd docker/; docker-compose up -d; cd ..`
+1. Copy [the Docker environment variables config file](.env.dist) and tune it with your desired values: `cp .env.dist .env`
+2. Start Docker and bring up the project needed containers: `docker-compose up -d`
 3. Create the database tables in your Docker MySQL container: `sbt createDbTables`
 
 ### Run the tests and start the HTTP server
 1. Enter into the SBT console: `sbt` 
 2. Run the tests: `t`
-3. Start the local server: `run`
+3. Start the local server: `app/run mooc-api` (if you run the app from outside SBT: `sbt "app/run mooc-api"`)
 4. Request for the server status: `curl http://localhost:8080/status`
 5. Take a look at the courses related to this repository (Spanish) just in case you're interested into them!
     * [Introducción a Scala](https://pro.codely.tv/library/introduccion-a-scala/63278/about/)
     * [API HTTP con Scala y Akka](https://pro.codely.tv/library/api-http-con-scala-y-akka/66747/about/)
+    * [Programación funcional: Refactorizando código orientado a objetos con TypeClasses](https://pro.codely.tv/library/programacion-funcional-refactorizando-codigo-orientado-a-objetos-con-typeclasses/about/)
+    * [Principios SOLID Aplicados](https://pro.codely.tv/library/principios-solid-aplicados/77070/about/)
+    * [Arquitectura Hexagonal](https://pro.codely.tv/library/arquitectura-hexagonal/66748/about/)
+    * [Command Query Responsibility Segregation](https://pro.codely.tv/library/cqrs-command-query-responsibility-segregation-3719e4aa/62554/about/)
+    * [Comunicación entre microservicios: Event-Driven Architecture](https://pro.codely.tv/library/comunicacion-entre-microservicios-event-driven-architecture/74823/about/)
+    * [Domain-Driven Design](https://pro.codely.tv/library/domain-driven-design-ddd/87157/about/)
 
 ### Pre-push Git hook
 
@@ -100,17 +106,17 @@ If you want more information on the logging policies and appenders, [take a look
 We use [SBT Native Packager](http://sbt-native-packager.readthedocs.io/en/latest/) in order to package the app in single Jar file that you can execute.
 
 1. Create the universal package: `sbt universal:packageBin`.
-2. Extract the generated zip: `unzip target/universal/codelytv-scala-http-api-1.0.zip -d ~/var/www/` which will contain:
+2. Extract the generated zip: `unzip target/universal/codelytv-cqrs-ddd-scala-example-1.0.zip -d ~/var/www/` which will contain:
     * `bin/`: All the executable binaries of our main classes in Unix and Windows (bat) format
     * `lib/`: All the project dependencies jar files.
 3. Run the main app binary:
-    * Without specifying any parameters (OK for this example app): `~/var/www/codelytv-scala-http-api-1.0/bin/codelytv-scala-http-api`
-    * Specifying parameters for the JVM: `~/var/www/codelytv-scala-http-api-1.0/bin/codelytv-scala-http-api -Dconfig.resource=application/$CONFIG_PATH`
-    * Specifying application parameters: `~/var/www/codelytv-scala-http-api-1.0/bin/codelytv-scala-http-api -Dconfig.resource=application/$CONFIG_PATH -- -appParam`
+    * Without specifying any parameters (OK for this example app): `~/var/www/codelytv-cqrs-ddd-scala-example-1.0/bin/codelytv-cqrs-ddd-scala-example`
+    * Specifying parameters for the JVM: `~/var/www/codelytv-cqrs-ddd-scala-example-1.0/bin/codelytv-cqrs-ddd-scala-example -Dconfig.resource=application/$CONFIG_PATH`
+    * Specifying application parameters: `~/var/www/codelytv-cqrs-ddd-scala-example-1.0/bin/codelytv-cqrs-ddd-scala-example -Dconfig.resource=application/$CONFIG_PATH -- -appParam`
 
 ## About
 
-This hopefully helpful utility has been developed by [CodelyTV](https://github.com/CodelyTV) and [contributors](https://github.com/CodelyTV/scala-http-api/graphs/contributors).
+This hopefully helpful utility has been developed by [CodelyTV](https://github.com/CodelyTV) and [contributors](https://github.com/CodelyTV/cqrs-ddd-scala-example/graphs/contributors).
 
 We'll try to maintain this project as simple as possible, but Pull Requests are welcome!
 

app/main/tv/codely/Starter.scala renamed to app/main/tv/codely/Launcher.scala

@@ -5,12 +5,12 @@ import tv.codely.backoffice.consumer.BackofficeConsumerApp
 import tv.codely.mooc.api.MoocApiApp
 import tv.codely.mooc.consumer.MoocConsumerApp
 
-object Starter {
+object Launcher {
   private val MoocApiArgument       = "mooc-api"
   private val MoocConsumersArgument = "mooc-consumers"
 
   private val BackofficeApiArgument       = "backoffice-api"
-  private val BackofficeConsumersArgument = "backoffice-api"
+  private val BackofficeConsumersArgument = "backoffice-consumers"
 
   def main(args: Array[String]): Unit = {
     if (args.length != 1) {

app/test/tv/codely/AcceptanceSpec.scala

@@ -14,10 +14,10 @@ import tv.codely.shared.infrastructure.dependency_injection.SharedModuleDependen
 import tv.codely.shared.infrastructure.doobie.{DoobieDbConnection, JdbcConfig}
 
 abstract class AcceptanceSpec extends WordSpec with Matchers with ScalaFutures with ScalatestRouteTest {
-  private val actorSystemName = "scala-http-api-acceptance-test"
+  private val actorSystemName = "cqrs-ddd-scala-example-acceptance-test"
 
   private val appConfig       = ConfigFactory.load("application")
-  private val dbConfig        = JdbcConfig(appConfig.getConfig("database"))
+  private val dbConfig        = JdbcConfig(appConfig.getConfig("acceptance-tests-database"))
   private val publisherConfig = RabbitMqConfig(appConfig.getConfig("message-publisher"))
 
   private val sharedDependencies = new SharedModuleDependencyContainer(actorSystemName, dbConfig, publisherConfig)

database/users.sql

@@ -7,4 +7,5 @@ CREATE TABLE users (
   UNIQUE KEY u_user_id (user_id)
 )
   ENGINE = InnoDB
-  DEFAULT CHARSET = utf8mb4;
+  DEFAULT CHARSET = utf8mb4
+  COLLATE=utf8mb4_unicode_ci;

database/videos.sql

@@ -10,4 +10,5 @@ CREATE TABLE videos (
   UNIQUE KEY u_video_id (video_id)
 )
   ENGINE = InnoDB
-  DEFAULT CHARSET = utf8mb4;
+  DEFAULT CHARSET = utf8mb4
+  COLLATE=utf8mb4_unicode_ci;

docker-compose.yml

@@ -0,0 +1,24 @@
+version: '3'
+
+services:
+  mysql:
+    container_name: codelytv-cqrs_ddd_scala_example-mysql
+    image: mysql:8.0
+    restart: unless-stopped
+    ports:
+      - "3316:3306"
+    env_file:
+      - .env
+    command: mysqld --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
+    volumes:
+      - ./etc/infrastructure/mysql/init:/docker-entrypoint-initdb.d
+
+  rabbitmq:
+    container_name: codelytv-cqrs_ddd_scala_example-rabbitmq
+    image: rabbitmq:3.7-management
+    restart: unless-stopped
+    ports:
+      - "5672:5672"
+      - "8181:15672"
+    env_file:
+      - .env

docker/.env.dist

@@ -0,0 +1,5 @@
+CREATE DATABASE IF NOT EXISTS `cqrs_ddd_scala_example`;
+CREATE DATABASE IF NOT EXISTS `cqrs_ddd_scala_example_acceptance_tests`;
+
+CREATE USER 'root'@'localhost' IDENTIFIED BY 'c0d3ly';
+GRANT ALL ON *.* TO 'root'@'%';

docker/docker-compose.yml

@@ -14,7 +14,7 @@ object Dependencies {
     "com.typesafe.akka"          %% "akka-stream"             % Versions.akka, // Explicit dependency due to: https://bit.ly/akka-http-25
     "com.typesafe.akka"          %% "akka-http-spray-json"    % Versions.akkaHttp,
     "org.tpolecat"               %% "doobie-core"             % "0.5.0",
-    "mysql"                      % "mysql-connector-java"     % "5.1.45",
+    "mysql"                      % "mysql-connector-java"     % "8.0.15",
     "com.github.scopt"           %% "scopt"                   % "3.7.0", // Command Line Commands such as de DbTablesCreator
     "ch.qos.logback"             % "logback-classic"          % "1.2.3", // Logging backend implementation
     "com.typesafe.scala-logging" %% "scala-logging"           % "3.7.2", // SLF4J Scala wrapper

etc/infrastructure/mysql/init/01-databases.sql

@@ -16,8 +16,8 @@ object DomainEventsMarshaller {
     }
 
     override def read(jv: JsValue): Message = jv.asJsObject.getFields("type") match {
-      case Seq(JsString("codelytv_scala_api.video_created"))   => jv.convertTo[VideoCreated]
-      case Seq(JsString("codelytv_scala_api.user_registered")) => jv.convertTo[UserRegistered]
+      case Seq(JsString("cqrs_ddd_scala_example.video_created"))   => jv.convertTo[VideoCreated]
+      case Seq(JsString("cqrs_ddd_scala_example.user_registered")) => jv.convertTo[UserRegistered]
       case Seq(JsString(unknown)) =>
         throw DeserializationException(s"Unknown message type to read <$unknown>")
     }

project/Dependencies.scala

@@ -2,4 +2,4 @@ include "akka-http"
 include "database"
 include "message-publisher"
 
-main-actor-system.name = "scala-http-api"
+main-actor-system.name = "cqrs-ddd-scala-example"

src/mooc/main/tv/codely/mooc/shared/infrastructure/marshaller/DomainEventsMarshaller.scala

@@ -1,6 +1,12 @@
 database {
-  driver = "com.mysql.jdbc.Driver",
-  url = "jdbc:mysql://127.0.0.1:3316/codelytv_scala_api?useUnicode=true&character_set_server=utf8mb4&verifyServerCertificate=false&useSSL=true",
-  user = "codelytv",
+  driver = "com.mysql.cj.jdbc.Driver",
+  url = "jdbc:mysql://127.0.0.1:3316/cqrs_ddd_scala_example?useUnicode=true&character_set_server=utf8mb4&sslMode=DISABLED",
+  user = "root",
+  password = "c0d3ly"
+}
+acceptance-tests-database {
+  driver = "com.mysql.cj.jdbc.Driver",
+  url = "jdbc:mysql://127.0.0.1:3316/cqrs_ddd_scala_example_acceptance_tests?useUnicode=true&character_set_server=utf8mb4&sslMode=DISABLED",
+  user = "root",
   password = "c0d3ly"
 }

src/shared/conf/application.conf

@@ -3,7 +3,7 @@ package tv.codely.shared.domain.bus
 import tv.codely.shared.domain.bus.Message.application
 
 object Message {
-  val application: String = "codelytv_scala_api"
+  val application: String = "cqrs_ddd_scala_example"
 }
 
 abstract class Message {

src/shared/conf/database.conf

@@ -9,8 +9,8 @@ final class RabbitMqMessagePublisher(channelFactory: RabbitMqChannelFactory) ext
 
   // Use the default nameless exchange in order to route the published messages based on
   // the mapping between the message routing key and the queue names.
-  // Example: A message with routing key "codelytv_scala_api.video_created"
-  // will be routed to the "codelytv_scala_api.video_created" queue.
+  // Example: A message with routing key "cqrs_ddd_scala_example.video_created"
+  // will be routed to the "cqrs_ddd_scala_example.video_created" queue.
   private val exchange = ""
 
   private def createQueueIfNotExists(name: String) = {

src/shared/main/tv/codely/shared/domain/bus/Message.scala

@@ -40,26 +40,33 @@ object DbTablesCreator {
     }
 
     parser.parse(args, CommandConfig()).fold(println("[ERROR] Invalid parameters")) { commandConfig =>
-      val dbConfig     = JdbcConfig(ConfigFactory.load("application").getConfig("database"))
-      val dbNameOption = for (grouped <- databaseNameFromUrlRegex findFirstMatchIn dbConfig.url) yield grouped group 1
+      connectAndExecute(databaseConfigKey = "database", createTables(commandConfig.tablesFolder))
+      connectAndExecute(databaseConfigKey = "acceptance-tests-database", createTables(commandConfig.tablesFolder))
+    }
+  }
 
-      dbNameOption.fold(
-        println(s"[ERROR] We couldn't extract the DB name from the DB URL configuration parameter: ${dbConfig.url}")
-      ) { dbName =>
-        Try(Class.forName(dbConfig.driver)).toOption.fold(
-          println(s"[ERROR] Invalid driver specified in the database config: ${dbConfig.driver}")
-        ) { _ =>
-          val connection = DriverManager.getConnection(dbConfig.url, dbConfig.user, dbConfig.password)
+  private def connectAndExecute(
+      databaseConfigKey: String,
+      commandToExecute: (String, Connection) => Unit
+  ): Unit = {
+    val dbConfig     = JdbcConfig(ConfigFactory.load("application").getConfig(databaseConfigKey))
+    val dbNameOption = for (grouped <- databaseNameFromUrlRegex findFirstMatchIn dbConfig.url) yield grouped group 1
 
-          createTables(dbName, commandConfig.tablesFolder, connection)
+    dbNameOption.fold(
+      println(s"[ERROR] We couldn't extract the DB name from the DB URL configuration parameter: ${dbConfig.url}")
+    ) { dbName =>
+      Try(Class.forName(dbConfig.driver)).toOption.fold(
+        println(s"[ERROR] Invalid driver specified in the database config: ${dbConfig.driver}")
+      ) { _ =>
+        val connection = DriverManager.getConnection(dbConfig.url, dbConfig.user, dbConfig.password)
 
-          connection.close()
-        }
+        commandToExecute(dbName, connection)
+
+        connection.close()
       }
     }
   }
-
-  private def createTables(dbName: String, tablesFolder: String, connection: Connection): Unit = {
+  private def createTables(tablesFolder: String)(dbName: String, connection: Connection): Unit = {
     val tablesFolderFile = new File(tablesFolder)
     val tablesFiles      = tablesFolderFile.listFiles()
 

src/shared/main/tv/codely/shared/infrastructure/bus/rabbitmq/RabbitMqMessagePublisher.scala

@@ -5,7 +5,7 @@ import org.slf4j.MDC
 import tv.codely.shared.domain.logger.Logger
 
 final class ScalaLoggingLogger extends Logger {
-  private val logger = ScalaLogging(name = "codelytv_scala_api")
+  private val logger = ScalaLogging(name = "cqrs_ddd_scala_example")
 
   override def info(message: String, context: Map[String, Any] = Map.empty): Unit =
     addContextParameters(context, log = logger.info(message))

src/shared/main/tv/codely/shared/infrastructure/environment/DbTablesCreator.scala

@@ -11,7 +11,7 @@ import tv.codely.shared.infrastructure.doobie.{DoobieDbConnection, JdbcConfig}
 import tv.codely.shared.infrastructure.unit.UnitTestCase
 
 trait IntegrationTestCase extends UnitTestCase {
-  private val actorSystemName = "scala-http-api-integration-test"
+  private val actorSystemName = "cqrs-ddd-scala-example-integration-test"
 
   private val appConfig       = ConfigFactory.load("application")
   private val dbConfig        = JdbcConfig(appConfig.getConfig("database"))

src/shared/main/tv/codely/shared/infrastructure/logger/ScalaLoggingLogger.scala

@@ -100,7 +100,7 @@ final class ScalaLoggingLoggerShould extends IntegrationTestCase {
       "@timestamp"  -> JsString("We'll not be able to compare this value"),
       "@version"    -> JsNumber(1),
       "message"     -> JsString(message),
-      "logger_name" -> JsString("codelytv_scala_api"),
+      "logger_name" -> JsString("cqrs_ddd_scala_example"),
       "thread_name" -> JsString(currentThreadName),
       "level"       -> JsString(level),
       "level_value" -> JsNumber(levelValue)