Initial commit

Author: ThomasKranitsas

docker-compose.yml

@@ -0,0 +1,21 @@
+version: '2'
+services:
+  database:
+    build: mysql
+    command: --default-authentication-plugin=mysql_native_password
+    restart: always
+    environment:
+      MYSQL_ROOT_PASSWORD: myPassword1
+      MYSQL_DATABASE: test
+  appswift:
+    build: server
+    depends_on: [database]
+    links:
+      - database
+    ports:
+      - "8080:8080"
+    environment:
+      DATABASE_NAME: test
+      DATABASE_HOST: database
+      DATABASE_USERNAME: root
+      DATABASE_PASSWORD: myPassword1

docs/README.md

@@ -0,0 +1,42 @@
+# Topcoder Starter Packs - Swift/Perfect and MySQL API
+
+## Deployment dependencies
+
+Before performing a Deployment, it's assumed that the following have been set up:
+
+- OS X 10.13.6+
+- Swift 4.2.1 (Perfect framework supports this version)
+- Docker
+
+## Organization of the submission
+- `server`- the directory with sample server written in Swift (with Perfect framework)
+- `mysql` - the directory with Dockerfile used to create MySQL image
+- `docs` - this directory contains the documentation, including this deployment guide
+
+## 3rd party libraries
+
+- Perfect and its subframeworks
+- SwiftyJSON
+
+## Configuration
+
+The server can be configured using environment variables or right in `server/SampleServer/Sources/SampleServer/Configuration.swift`:
+The environment variables should be provided in `docker-comppose.yml`:
+- `DATABASE_NAME` - the database name. Check that content of `mysql/Docker` and make sure the database name is the same;
+- `DATABASE_HOST` - the host where MySQL is installed. It should be the name of the corresponding container if launched in a "docker network";
+- `DATABASE_USERNAME` - database username used to connect;
+- `DATABASE_PASSWORD` - database password used to connect.
+
+## Launch the database and sample server
+```
+docker-compose up --build
+```
+
+## Debug and test server and MySQL separately 
+
+Follow README.md files in `server/` and `mysql/` directories for more information.
+
+## Verification
+
+1. Launch the containers using `docker-compose up --build` command as mentioned above
+2. Use Postman sample requests provided in `docs/postman` to verify the server.

docs/postman/Swift Server.postman_collection.json

@@ -0,0 +1,80 @@
+{
+	"info": {
+		"_postman_id": "e7b9fda9-049b-46d6-a57a-fefd2b444cbb",
+		"name": "Swift Server",
+		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+	},
+	"item": [
+		{
+			"name": "Get All",
+			"request": {
+				"method": "GET",
+				"header": [],
+				"url": {
+					"raw": "{{URL}}/test",
+					"host": [
+						"{{URL}}"
+					],
+					"path": [
+						"test"
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "Update",
+			"request": {
+				"method": "PUT",
+				"header": [],
+				"body": {
+					"mode": "raw",
+					"raw": "{\n\t\"handle\": \"updated2\"\n}"
+				},
+				"url": {
+					"raw": "{{URL}}/test/00000000-0000-0000-D9EF-0B0000000000",
+					"host": [
+						"{{URL}}"
+					],
+					"path": [
+						"test",
+						"00000000-0000-0000-D9EF-0B0000000000"
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "Update",
+			"request": {
+				"method": "POST",
+				"header": [],
+				"body": {
+					"mode": "raw",
+					"raw": "{\n\t\"handle\": \"sdfsdF\"\n}"
+				},
+				"url": {
+					"raw": "{{URL}}/test",
+					"host": [
+						"{{URL}}"
+					],
+					"path": [
+						"test"
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "Delete",
+			"request": {
+				"method": "GET",
+				"header": [],
+				"url": {
+					"raw": ""
+				}
+			},
+			"response": []
+		}
+	]
+}

docs/postman/Swift Server.postman_environment.json

@@ -0,0 +1,15 @@
+{
+	"id": "e203cccf-8653-4ac4-959f-2050faa65c1d",
+	"name": "Swift Server",
+	"values": [
+		{
+			"key": "URL",
+			"value": "localhost:8080",
+			"description": "",
+			"enabled": true
+		}
+	],
+	"_postman_variable_scope": "environment",
+	"_postman_exported_at": "2019-10-12T17:36:25.362Z",
+	"_postman_exported_using": "Postman/7.9.0"
+}

mysql/Dockerfile

@@ -0,0 +1,7 @@
+# Create from official mysql image
+FROM mysql:5.7
+
+# Add content of the sql-scripts directory to your image
+# All scripts in docker-entrypoint-initdb.d/ are automatically
+# executed during container startup
+ADD ./sql-scripts /docker-entrypoint-initdb.d/

mysql/README.md

@@ -0,0 +1,14 @@
+# Create image
+```
+docker build -t database-test .
+```
+
+# Start new MySQL container from the image
+```
+docker run -d -p 3336:3306 --name database-test1 -e MYSQL_ROOT_PASSWORD=myPassword database-test
+```
+
+# Connect to container to verify what's inside
+```
+docker exec -it database-test1 bash
+```

mysql/sql-scripts/create.sql

@@ -0,0 +1,5 @@
+CREATE TABLE `Model` (
+  `id` varchar(36) NOT NULL,
+  `handle` longtext NOT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8

server/Dockerfile

@@ -0,0 +1,15 @@
+#An Ubuntu 16.04 image with Swift preinstalled
+FROM seriyvolk83/swift4.2.1
+
+# Copy application
+COPY . /app
+
+# Build application
+RUN swift --version
+RUN swift build -c release --package-path /app/SampleServer --build-path /app/SampleServer/.build
+
+# Make port 8080 available to the world outside this container
+EXPOSE 8080
+
+# Run the server when container is launched
+CMD ["/app/SampleServer/.build/release/SampleServer"]

server/README.md

@@ -0,0 +1,45 @@
+
+# 1. Clean previous bluild
+```
+cd SampleServer
+swift package clean
+rm -rf .build
+```
+
+# 2. Build
+
+Follow "development version" if you test the server locally, not as a part of container.
+
+## Development version
+```
+cd SampleServer
+swift build
+```
+## Release version
+```
+cd SampleServer
+swift build -c release
+```
+## Build from current dir (the project is in SampleServer)
+```
+swift build --package-path SampleServer --build-path SampleServer/.build
+```
+
+# 3. Xcode project
+
+To generate Xcode project:
+```
+cd SampleServer
+swift package generate-xcodeproj
+```
+
+# 4. Try to run it locally
+
+## Run development version
+```
+.build/debug/SampleServer
+```
+## Run release version
+```
+.build/release/SampleServer
+```

server/SampleServer/Package.resolved

@@ -0,0 +1,19 @@
+// swift-tools-version:4.2
+
+import PackageDescription
+
+let package = Package(
+	name: "SampleServer",
+	products: [
+		.executable(name: "SampleServer", targets: ["SampleServer"])
+	],
+	dependencies: [
+		.package(url: "https://github.com/PerfectlySoft/Perfect-HTTPServer.git", from: "3.0.0"),
+        .package(url: "https://github.com/PerfectlySoft/Perfect-MySQL.git", from: "3.0.0"),
+        .package(url: "https://github.com/SwiftyJSON/SwiftyJSON.git", from: "4.2.0"),
+//        .package(url: "https://gitlab.com/seriyvolk83/SwiftEx.git", from: "0.0.7"), dodo
+	],
+	targets: [
+		.target(name: "SampleServer", dependencies: ["PerfectHTTPServer", "PerfectMySQL", "SwiftyJSON"])
+	]
+)