Merge pull request #1 from IObert/master

Add exercise 10 for Cloud Foundry deployment

Author: qmacro

README.md

@@ -33,7 +33,7 @@ Here's an overview of the exercises in this CodeJam.
 - [Exercise 07 - Defining a second service](exercises/07/)
 - [Exercise 08 - Adding custom logic, and debugging](exercises/08/)
 - [Exercise 09 - Introducing an app at the UI layer](exercises/09/)
-- [Exercise 10 - (Bonus) Deploy a simple project to the Cloud](exercises/10/)
+- [Exercise 10 - Deploy a simple project to the Cloud](exercises/10/)
 
 ### Feedback
 
@@ -60,5 +60,3 @@ Support for the content in this repository is available during CodeJam events, f
 Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
 
 This file is licensed under the SAP Sample Code License except as noted otherwise in the [LICENSE](LICENSE) file.
-
-

exercises/01/readme.md

@@ -81,6 +81,12 @@ When successfully installed, you should see the extension thus:
 
 ![CDS Language Support extension installed in VS Code](vscode-extension.png)
 
+### 3. Install the MultiApp Build Tool (mbt)
+This tool allows you in package your project into a deployable archieve.
+```
+npm install -g mbt
+```
+
 ## Summary
 
 You've now installed the two key tools for developing with CAP locally, and are all set to create your first project.
@@ -94,4 +100,3 @@ You've now installed the two key tools for developing with CAP locally, and are
 1. What is the significance of using the `--global` option when installing the `@sap/cds` package?
 
 1. What is the meaning of the `.vsix` file type for the VS Code extension? Can we dig into that to see what's inside?
-

exercises/02/basic-odata-service.png

@@ -65,31 +65,30 @@ user@host:~
 => cds init --help
 ```
 
-Amongst other things, you should see a `--modules` option to specify a list of modules to be created when the project is initialized, and also a `--verbose` option.
+Amongst other things, you should see a `--modules` option to specify a list of modules to be created when the project is initialized, and also a `--verbose` option. The options `--mta`, `--db-technology` and `--insecure` are related to deployment to Cloud Foundry and its access management.
 
-:point_right: Use both of these options to initialize a new project directory thus:
+:point_right: Use all of these options to initialize a new project directory thus:
 
 ```sh
 user@host:~
-=> cds init --modules db,srv --verbose bookshop
+=> cds init --modules db,srv --mta --insecure --db-technology hana --verbose bookshop
 ```
 
 You should see output that looks similar to this:
 
-```sh
-Creating new project in directory bookshop.
-
-Copying templates for type db to bookshop/db ...
-Copying templates for type srv to bookshop/srv ...
-Updating npm dependencies in bookshop/package.json ...
+```
+[Warn] Srv type nodejs only supports odata version v4 and not v2. Will use v4.
+Initializing project in folder bookshop.
+Copying templates for type db to db ...
+Creating mta file /Users/d056949/SoftwareDev/sandbox/bookshop/mta.yaml ...
+Copying templates for type srv to {{moduleFolder}} ...
+Creating mta file /Users/d056949/SoftwareDev/sandbox/bookshop/mta.yaml ...
+Updating npm dependencies in /Users/d056949/SoftwareDev/sandbox/bookshop/package.json ...
 Running npm install...
-npm WARN bookshop@1.0.0 license should be a valid SPDX license expression
-
-added 76 packages from 109 contributors and audited 166 packages in 3.261s
+added 81 packages from 111 contributors and audited 176 packages in 2.976s
 found 0 vulnerabilities
 
-
-Project creation was successful.
+Finished successfully.
 ```
 
 
@@ -123,6 +122,7 @@ Briefly, the directories and contents can be described thus:
 | `db` | Where the data models (in CDS) are specified. A skeleton CDS project that has been initialized with the `--modules db` option will have a basic data model file in the form of `data-model.cds` with a small sample definition, like here |
 | `node_modules` | This is the normal place where NPM packages (modules) are to be found in a Node.js based project |
 | `srv` | Where the service definitions (in CDS) are specified. A skeleton CDS project that has been initialized with the `--modules srv` option will have a basic service definition file in the form of `cat-service.cds` with a small service definition, like here |
+| `mta.yaml` | This is the central descriptor file for the project. It defines all modules (microservices) and backing services (like databases). This information will be used (a) to build the .mtar archive during design time and to deploy and provision the apps and services during deploy time. |
 
 Besides the directories there are also a number of files, including the project's `package.json` (present in any Node.js based project) and a readme file.
 
@@ -158,14 +158,15 @@ Note: You can also specify simply `cds serve all` to have `cds` look for appropr
 You should see output similar to this:
 
 ```
-[cds] - server listening at http://localhost:4004
+[cds] - connect to datasource - hana:db,srv
 [cds] - serving CatalogService at /catalog
 [cds] - service definitions loaded from:
 
  srv/cat-service.cds
  db/data-model.cds
 
-[cds] - launched in: 448.633ms
+[cds] - server listens at http://localhost:4004 ... (terminate with ^C)
+[cds] - launched in: 566.451ms
 ```
 
 The OData service is now running, and available on [http://localhost:4004](http://localhost:4004).
@@ -183,7 +184,7 @@ The [catalog](http://localhost:4004/catalog) link will take you to the service d
 
 :point_right: Explore the metadata document and familiarize yourself with the content. Note the entityset definition and the entity type describing the `Books` entity. Note also the annotations describing particular service capabilities.
 
-:point_right: There is also a link to the [Books](http://localhost:4004/catalog/Books) entityset. Follow this link to see what the service returns.
+:point_right: There is also a link to the [Books](http://localhost:4004/catalog/Books) entityset. Follow this link to see what the service returns. Check what happens to the node process when you try to access the entityset.
 
 
 ## Summary
@@ -200,3 +201,5 @@ With a single command, you've initialized a basic OData service project and with
 1. What are the annotations in the metadata document describing, and where do they come from?
 
 1. What does the Books entityset resource contain right now?
+
+1. What happened to the node process when you accessed the entityset? Can you think of reasons why this happened?

exercises/02/initialized-project-in-vscode.png

@@ -105,7 +105,50 @@ Don't forget to save the file.
 
 As it stands, the OData service has no storage. We can actually simulate storage with [service provider](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/b9c34890348b4f2184e07a6731bce50b.html) logic in JavaScript but that's not a path we want to explore right now (we'll look at it in [exercise 08](../08/)). Instead, we'll use a real database in the form of [SQLite](https://sqlite.org) and deploy the data model and service definition to it.
 
-_Note: From cds 3.10 onwards, the `sqlite3` package is automatically installed in the project for you as a development dependency so it's all ready for you to start using._
+:point_right: Update the database definition in `package.json` to include a SQLite DB for local testing. This will fix the issue you encountered before when the node process crashed. Currently, you'll see a section that describes the persistence layer configuration:
+
+```json
+"cds": {
+ "requires": {
+ "db": {
+ "kind": "hana",
+ "model": [
+ "db",
+ "srv"
+ ]
+ }
+ },
+ "odata": {
+ "version": "v4"
+ }
+}
+```
+To prepare the app for a multiple databases, change the content to:
+```json
+"cds": {
+ "requires": {
+ "db": {
+ "kind": "sqlite",
+ "model": ["db", "srv"],
+ "credentials": {
+ "database": "bookshop.db"
+ },
+ "[production]": {
+ "kind": "hana"
+ }
+ }
+ },
+ "odata": {
+ "version": "v4"
+ }
+}
+```
+
+:point_right: As we want to use a local SQLite database, we need to install a client to communicate with this DB. Install the `sqlite3` package for this job.
+```
+npm install -D sqlite3
+```
+
 
 :point_right: Explore the `cds deploy` command like this:
 
@@ -128,34 +171,10 @@ Use this command to deploy the data model and service definition to a new SQLite
 
 ```
 user@host:~/bookshop
-=> cds deploy --to sqlite:bookshop.db
-```
-
-This should complete fairly quietly, and give a message like this:
-
-```
-- updated package.json
-```
-
-Note: If you're wondering what is been updated in `package.json` relating to the use of SQLite, have a look. You'll see a section that describes the persistence layer configuration:
-
-```json
- "cds": {
- "requires": {
- "db": {
- "kind": "sqlite",
- "model": [
- "db",
- "srv"
- ],
- "credentials": {
- "database": "bookshop.db"
- }
- }
- }
- }
+=> cds deploy
 ```
 
+This should complete fairly quietly.
 
 ### 5. Explore the new database
 

exercises/02/integrated-terminal-in-view.png

@@ -1,4 +1,4 @@
-ID,name
+ID,NAME
 42,Douglas Adams
 101,Emily Brontë
 107,Charlote Brontë

exercises/02/readme.md

@@ -1,4 +1,4 @@
-ID,title,author_ID,stock
+ID,TITLE,AUTHOR_ID,STOCK
 421,The Hitch Hiker's Guide To The Galaxy,42,1000
 427,"Life, The Universe And Everything",42,95
 201,Wuthering Heights,101,12