Make test more robust against future model changes

Compare subset of JSON, not full JSON.

.gitignore

@@ -13,3 +13,5 @@ target/
 connection.properties
 default-env.json
 packages/messageBox
+*.db
+

.npmrc

@@ -1 +1 @@
-@sap:registry=https://npm.sap.com
+@sap:registry=https://npm.sap.com

.vscode/launch.json

@@ -9,8 +9,16 @@
       "request": "launch",
       "type": "node",
       "runtimeExecutable": "npx",
-      "runtimeArgs": ["-n"],
-      "args": ["--", "cds", "run", "--with-mocks", "--in-memory?"], // the leading "--" arg ensures it works with as well as without debugging
+      "runtimeArgs": [
+        "-n"
+      ],
+      "args": [
+        "--",
+        "cds",
+        "run",
+        "--with-mocks",
+        "--in-memory"
+      ], // the leading "--" arg ensures it works with as well as without debugging
       "cwd": "${workspaceFolder}/packages/${input:service}",
       "console": "integratedTerminal",
       "serverReadyAction": {
@@ -18,7 +26,9 @@
         "uriFormat": "http://localhost:%s",
         "action": "openExternally"
       },
-      "skipFiles": ["<node_internals>/**"]
+      "skipFiles": [
+        "<node_internals>/**"
+      ]
     }
   ],
   "inputs": [
@@ -36,7 +46,7 @@
         "reviews-service",
         "user-service"
       ],
-      "default": "bookstore"
+      "default": "bookshop"
     }
   ]
-}
+}

README.md

@@ -11,7 +11,7 @@ In SAP Business Application Studio, open a terminal.
 Then clone the repo with this specific branch:
 
 ```sh
-git clone https://github.com/sap-samples/cloud-cap-samples projects/cloud-cap-samples -b openSAP-week4-unit3-final
+git clone https://github.com/sap-samples/cloud-cap-samples projects/cloud-cap-samples -b openSAP-week2-unit4567
 cd projects/cloud-cap-samples
 ```
 
@@ -20,6 +20,16 @@ In the `cloud-cap-samples` folder run:
 npm install
 ```
 
+### Cloud Foundry Login
+This is required later in the demo.  In Studio's terminal, execute:
+```sh
+cf login
+```
+As input, provide
+- The Cloud Foundry API endpoint, which is usally `https://api.cf.eu10.hana.ondemand.com`.  It can be obtained from the Overview page of your Subaccount in Cloud Cockpit.
+- Your user's email address and password
+- The name of your trial organization and space
+
 ## Run
 
 Now you're ready to run the samples, for example:

package.json

@@ -9,20 +9,18 @@
     "install": "(npm -s run lerna) && lerna bootstrap --hoist",
     "lerna": "npx --no-install lerna -v > /dev/null || npm i lerna --no-save",
     "test": "jest",
-    "bookshop-enhanced": "cds watch packages/bookshop-enhanced",
-    "bookshop": "cds watch packages/bookshop",
-    "bookstore": "cds watch packages/bookstore",
-    "products-service": "cds watch packages/products-service",
-    "reviews-service": "cds watch packages/reviews-service"
+    "bookshop": "cds watch packages/bookshop"
   },
   "dependencies": {
     "@sap/cds": "^3",
     "express": "^4"
   },
-  "--add-these-to-devDependencies-for-tests": {
+  "devDependencies": {
     "@types/jest": "*",
     "sqlite3": "*",
-    "jest": "*"
+    "jest": "*",
+    "supertest": "^4.0.2",
+    "@sap/hdi-deploy": "3.7.0"
   },
   "license": "SAP SAMPLE CODE LICENSE"
 }

packages/bookshop/.vscode/launch.json

@@ -0,0 +1,31 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Run bookshop",
+      "request": "launch",
+      "type": "node",
+      "cwd": "/home/user/projects/cloud-cap-samples/packages/bookshop",
+      "runtimeExecutable": "npx",
+      "runtimeArgs": [
+        "-n"
+      ],
+      "args": [
+        "--",
+        "cds",
+        "run",
+        "--in-memory?"
+      ],
+      "console": "internalConsole",
+      "internalConsoleOptions": "openOnSessionStart",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "env": {
+        "run.config": "{\"handlerId\":\"cap_run_config_handler_id\",\"runnableId\":\"/home/user/projects/cloud-cap-samples/packages/bookshop\"}"
+      }
+    }
+  ]
+}

packages/bookshop/app/fiori.html

@@ -43,7 +43,7 @@
 	<script src="https://sapui5.hana.ondemand.com/resources/sap-ui-core.js"
     	data-sap-ui-libs="sap.m, sap.ushell, sap.collaboration, sap.ui.layout"
     	data-sap-ui-compatVersion="edge"
-    	data-sap-ui-theme="sap_belize"
+    	data-sap-ui-theme="sap_fiori_3"
     	data-sap-ui-frameOptions="allow"
 	></script>
 	<script>

packages/bookshop/db/data/sap.capire.bookshop-Orders.csv

@@ -1,5 +1,3 @@
-ID;modifiedAt;createdAt;createdBy;modifiedBy;OrderNo;currency_code;status
-da86efd0-4ba1-4078-b7f0-5c9c530297f7;;2019-01-31;ALICE;;1;EUR;processing
-2f2f2640-6866-4dcf-8f4d-3027aa831cad;;2019-03-25;ALICE;;10;EUR;completed
-64e718c9-ff99-47f1-8ca3-950c850777d4;;2019-01-30;BOB;;2;EUR;processing
-1af3322d-3cb1-46be-b312-0ae9ec311537;;2019-03-16;BOB;;9;EUR;completed
+ID;modifiedAt;createdAt;createdBy;modifiedBy;OrderNo;currency_code
+7e2f2640-6866-4dcf-8f4d-3027aa831cad;;2019-01-31;john.doe@test.com;;1;EUR
+64e718c9-ff99-47f1-8ca3-950c850777d4;;2019-01-30;jane.doe@test.com;;2;EUR

packages/bookshop/db/schema.cds

@@ -1,50 +1,35 @@
 namespace sap.capire.bookshop;
-
-using {
-  Currency,
-  managed,
-  cuid
-} from '@sap/cds/common';
-
-type Status : String enum {
-  completed;
-  processing;
-  blocked;
-}
+using { Currency, managed, cuid } from '@sap/cds/common';
 
 entity Books : managed {
-  key ID       : Integer;
-      title    : localized String(111);
-      descr    : localized String(1111);
-      author   : Association to Authors;
-      stock    : Integer;
-      price    : Decimal(9, 2);
-      currency : Currency;
-}
-
-entity Authors : managed {
-  key ID           : Integer;
-      name         : String(111);
-      dateOfBirth  : Date;
-      dateOfDeath  : Date;
-      placeOfBirth : String;
-      placeOfDeath : String;
-      books        : Association to many Books
-                       on books.author = $self;
-}
-
-entity Orders : cuid, managed {
-  OrderNo  : String       @title : 'Order Number'; //> readable key
-   status   : Status default 'processing';
-   Items    : Composition of many OrderItems
-               on Items.parent = $self;
-  total    : Decimal(9, 2)@readonly;
+  key ID : Integer;
+  title  : localized String(111);
+  descr  : localized String(1111);
+  author : Association to Authors;
+  stock  : Integer;
+  price  : Decimal(9,2);
   currency : Currency;
 }
 
+entity Authors : managed {
+  key ID : Integer;
+  name   : String(111);
+  dateOfBirth  : Date;
+  dateOfDeath  : Date;
+  placeOfBirth : String;
+  placeOfDeath : String;
+  books  : Association to many Books on books.author = $self;
+}
+
+entity Orders : cuid, managed {
+  OrderNo  : String @title:'Order Number'; //> readable key
+  Items    : Composition of many OrderItems on Items.parent = $self;
+  total    : Decimal(9,2) @readonly;
+  currency : Currency;
+}
 entity OrderItems : cuid {
   parent    : Association to Orders;
   book      : Association to Books;
   amount    : Integer;
-  netAmount : Decimal(9, 2);
-}
+  netAmount : Decimal(9,2);
+}

packages/bookshop/package.json

@@ -6,27 +6,13 @@
   "dependencies": {
     "@sap/cds": "^3",
     "express": "^4",
-    "@sap/xb-msg-amqp-v100": "^0.9.35"
+    "hdb": "^0.17.1"
   },
   "devDependencies": {
-    "sqlite3": "^4.1.1"
+    "jest": "*"
   },
   "scripts": {
-    "start": "npx cds run"
-  },
-  "cds": {
-    "requires": {
-      "API_BUSINESS_PARTNER": {
-        "kind": "odata",
-        "model": "srv/external/API_BUSINESS_PARTNER",
-        "--credentials": {
-          "prefix": "sap/S4HANAOD/c098/BO",
-          "destination": "cap-api098"
-        }
-      },
-      "--messaging": {
-        "kind": "enterprise-messaging"
-      }
-    }
+    "start": "npx cds run",
+    "test": "jest"
   }
 }

packages/bookshop/req.http

@@ -1,6 +0,0 @@
-PATCH http://localhost:4004/api-business-partner/A_BusinessPartner('ALICE')
-Content-Type: application/json
-
-{
-    "BusinessPartnerIsBlocked": true
-}

packages/bookshop/srv/admin-service.cds

@@ -8,9 +8,8 @@ service AdminService @(_requires:'authenticated-user') {
 
 // Enable Fiori Draft for Orders
 annotate AdminService.Orders with @odata.draft.enabled;
-// annotate AdminService.Books with @odata.draft.enabled;
 
-// Temporary workaround -> https://github.wdf.sap.corp/cap/issues/issues/3121
+// Temporary workaround -> cap/issues#3121
 extend service AdminService with {
   entity OrderItems as select from my.OrderItems;
 }

packages/bookshop/srv/admin-service.js

@@ -0,0 +1,22 @@
+const cds = require('@sap/cds')
+
+/** Service implementation for AdminService */
+module.exports = cds.service.impl(srv => {
+  const { OrderItems } = srv.entities ('sap.capire.bookshop')
+
+  srv.after (['READ','EDIT'], 'Orders', _calculateTotals)
+ 
+  // on-the-fly calculate the total Order price based on the OrderItems' netAmounts
+  async function _calculateTotals (orders, req) {
+    const ordersByID = Array.isArray(orders)
+      ? orders.reduce ((all,o) => { (all[o.ID] = o).total=0; return all },{})
+      : { [orders.ID]: orders }
+    return cds.transaction(req) .run (
+      SELECT.from(OrderItems) .columns ('parent_ID', 'netAmount')
+       .where ({ parent_ID: {in: Object.keys(ordersByID)} })
+    ) .then (items =>
+      items.forEach (item => ordersByID [item.parent_ID] .total += item.netAmount)
+    )
+  }
+
+})

packages/bookshop/srv/cat-service.cds

@@ -1,25 +1,13 @@
 using { sap.capire.bookshop as my } from '../db/schema';
-using { API_BUSINESS_PARTNER as external } from './external/API_BUSINESS_PARTNER.csn';
 
 @path:'/browse'
+// @impl: './cat-service.js'
 service CatalogService {
 
   @readonly entity Books as SELECT from my.Books {*,
     author.name as author
   } excluding { createdBy, modifiedBy };
 
-  @readonly entity BusinessPartners as projection on external.A_BusinessPartner {
-    key BusinessPartner as ID,
-    FirstName,
-    MiddleName,
-    LastName,
-    BusinessPartnerIsBlocked
-  };
-
-  event OrderBlocked {
-    ID: UUID;
-  };
-
   @requires_: 'authenticated-user'
   @insertonly entity Orders as projection on my.Orders;
 

packages/bookshop/srv/cat-service.js

@@ -1,41 +1,28 @@
 const cds = require('@sap/cds')
+const { Books } = cds.entities
 
 /** Service implementation for CatalogService */
-module.exports = cds.service.impl(async function () {
-  const { Books, Orders, BusinessPartners } = this.entities
-  const bupaSrv = await cds.connect.to('API_BUSINESS_PARTNER')
-  this.after('READ', Books, each => each.stock > 111 && _addDiscount2(each, 11))
-  this.before('CREATE', Orders, _reduceStock)
-  this.on('READ', BusinessPartners, req => bupaSrv.tx(req).run(req.query))
-
-  /** Block orders if business partner is blocked */
-  bupaSrv.on('BusinessPartner/Changed', async msg => {
-    console.log('>> Received BusinessPartner/Changed', msg.data)
-    const BUSINESSPARTNER = msg.data.KEY[0].BUSINESSPARTNER
-    const tx = cds.tx(msg)
-    const orders = await tx.run(SELECT('ID').from(Orders).where({ createdBy: BUSINESSPARTNER, status: 'processing' }))
-    if (!orders.length) return
-    const businessPartner = await bupaSrv.tx(msg).run(SELECT.one('BusinessPartnerIsBlocked').from(BusinessPartners).where({ ID: BUSINESSPARTNER }))
-    if (!businessPartner || !businessPartner.BusinessPartnerIsBlocked) return
-    await Promise.all(orders.map(order => tx.run(UPDATE(Orders).where(order).set({ status: 'blocked' }))))
-    orders.forEach(order => this.emit('OrderBlocked', order) && console.log('>> Emitted OrderBlocked', order))
-  })
-
-  /** Add some discount for overstocked books */
-  function _addDiscount2(each, discount) {
-    each.title += ` -- ${discount}% discount!`
-  }
-
-  /** Reduce stock of ordered books if available stock suffices */
-  async function _reduceStock(req) {
-    const { Items: OrderItems } = req.data
-    return cds.transaction(req).run(() => OrderItems.map(order =>
-      UPDATE(Books).set('stock -=', order.amount)
-        .where('ID =', order.book_ID).and('stock >=', order.amount)
-    )).then(all => all.forEach((affectedRows, i) => {
-      if (affectedRows === 0) req.error(409,
-        `${OrderItems[i].amount} exceeds stock for book #${OrderItems[i].book_ID}`
-      )
-    }))
-  }
+module.exports = cds.service.impl(srv => {
+  srv.after ('READ', 'Books', each => each.stock > 111 && _addDiscount2(each,11))
+  srv.before ('CREATE', 'Orders', _reduceStock)
+  // srv.before ('*', (req) => { console.debug ('>>>', req.method, req.target.name) })
 })
+
+/** Add some discount for overstocked books */
+function _addDiscount2 (each,discount) {
+  each.title += ` -- ${discount}% discount!`
+}
+/** Reduce stock of ordered books if available stock suffices */
+async function _reduceStock (req) {
+  const { Items: orderItems } = req.data
+
+  return cds.transaction(req) .run (()=> orderItems.map (item =>
+    UPDATE (Books)
+      .set ('stock -=', item.amount)
+      .where ('ID =', item.book_ID) .and ('stock >=', item.amount)
+  )).then (all => all.forEach ((affectedRows,i) => {
+    if (affectedRows === 0) {
+      req.error (409, `${orderItems[i].amount} exceeds stock for book #${orderItems[i].book_ID}`)
+    }
+  }))
+}

packages/bookshop/srv/external/API_BUSINESS_PARTNER.js

@@ -1,9 +0,0 @@
-module.exports = srv => {
-    srv.on(['CREATE', 'UPDATE', 'DELETE'], req => {
-        const payload = {
-            KEY: [{ BUSINESSPARTNER: req.data.BusinessPartner }]
-        }
-        srv.emit('BusinessPartner/Changed', payload)
-        console.log('<< Emitted BusinessPartner/Changed', payload)
-    })
-}

packages/bookshop/srv/external/data/API_BUSINESS_PARTNER-A_BusinessPartner.csv

@@ -1,4 +0,0 @@
-BusinessPartner;FirstName;MiddleName;LastName;BusinessPartnerIsBlocked
-ALICE;Alice;In;Wonderland;false
-BOB;Bob;The;Builder;false
-JABBA;Jabba;The;Hutt;true

packages/bookshop/tests/bookshop.test.js

@@ -0,0 +1,79 @@
+
+const cds = require('@sap/cds')
+
+describe('Bookshop: OData Protocol Level Testing', () => {
+  jest.setTimeout(20*1000)
+  const app = require('express')()
+  const request = require('supertest')(app)
+
+  beforeAll(async () => {
+    await cds.deploy(__dirname + '/../srv/cat-service').to('sqlite::memory:')
+    await cds.serve('CatalogService').from(__dirname + '/../srv/cat-service').in(app)
+  })
+
+  it('Service $metadata document', async () => {
+    const response = await request
+      .get('/browse/$metadata')
+      .expect('Content-Type', /^application\/xml/)
+      .expect(200)
+
+    const expectedVersion = '<edmx:Edmx Version="4.0" xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx">'
+    const expectedBooksEntitySet = '<EntitySet Name="Books" EntityType="CatalogService.Books">'
+    expect(response.text.includes(expectedVersion)).toBeTruthy()
+    expect(response.text.includes(expectedBooksEntitySet)).toBeTruthy()
+  })
+
+
+  it('Get with select, expand and localized', async () => {
+    const response = await request
+      .get('/browse/Books?$select=title,author&$expand=currency')
+      .set('Accept-Language', 'de')
+      .expect('Content-Type', /^application\/json/)
+      .expect(200)
+
+    expect(response.body.value).toMatchObject([
+      {
+        ID: 201, title: "Sturmhöhe", author: "Emily Brontë",
+        currency: { name: "Pfund", descr: "Britische Pfund", code: "GBP", symbol: "£" }
+      },
+      {
+        ID: 207, title: "Jane Eyre", author: "Charlotte Brontë",
+        currency: { name: "Pfund", descr: "Britische Pfund", code: "GBP", symbol: "£" }
+      },
+      {
+        ID: 251, title: "The Raven", author: "Edgar Allen Poe",
+        currency: { name: "US-Dollar", descr: "United States Dollar", code: "USD", symbol: "$" }
+      },
+      {
+        ID: 252, title: "Eleonora", author: "Edgar Allen Poe",
+        currency: { name: "US-Dollar", descr: "United States Dollar", code: "USD", symbol: "$" }
+      },
+      {
+        ID: 271, title: "Catweazle", author: "Richard Carpenter",
+        currency: { name: "Euro", descr: "European Euro", code: "EUR", symbol: "€" }
+      }
+    ])
+  })
+})
+
+describe('Bookshop: CDS Service Level Testing', () => {
+  let srv, Books
+
+  beforeAll(async () => {
+    srv = await cds.serve('CatalogService').from(__dirname + '/../srv/cat-service')
+    Books = srv.entities.Books
+    expect(Books).toBeDefined()
+  })
+
+  it('GETs all books', async () => {
+    const books = await srv.read(Books, b => { b.title })
+
+    expect(books).toMatchObject([
+      { title: 'Wuthering Heights' },
+      { title: 'Jane Eyre' },
+      { title: 'The Raven' },
+      { title: 'Eleonora' },
+      { title: 'Catweazle' }
+    ])
+  })
+})