Compare commits

..

5 Commits

Author SHA1 Message Date
Heiko Witteborg
62f32abf74 Prepare for serve_on_root false 2023-06-16 10:09:40 +02:00
Christian Georgi
536282388c Better clone path 2020-04-20 17:08:04 +02:00
Christian Georgi
75e767ed5c Add package-lock.json, fix readme 2020-04-02 15:47:34 +02:00
Christian Georgi
ba1eead6db Update readme 2020-03-23 17:06:45 +01:00
Elena Oresharova
8233703815 Add unit 3 content 2020-03-22 11:55:22 +01:00
23 changed files with 449 additions and 1113 deletions

2
.npmrc
View File

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

41
.vscode/launch.json vendored
View File

@@ -5,45 +5,18 @@
"version": "0.2.0",
"configurations": [
{
"name": "bookshop",
"request": "launch",
"type": "node",
"runtimeExecutable": "npx",
"runtimeArgs": [
"-n"
],
"args": [
"--",
"cds",
"run",
"--in-memory"
],
"name": "bookshop", "request": "launch", "type": "node", "runtimeExecutable": "npx", "runtimeArgs": [ "-n" ],
"args": [ "--", "cds", "run", "--in-memory" ],
"cwd": "${workspaceFolder}/packages/bookshop",
"console": "integratedTerminal",
"skipFiles": [
"<node_internals>/**"
]
"skipFiles": ["<node_internals>/**"]
},
{
"name": "cds run ...",
"request": "launch",
"type": "node",
"runtimeExecutable": "npx",
"runtimeArgs": [
"-n"
],
"args": [
"--",
"cds",
"run",
"--with-mocks",
"--in-memory?"
],
"name": "cds run ...", "request": "launch", "type": "node", "runtimeExecutable": "npx", "runtimeArgs": [ "-n" ],
"args": [ "--", "cds", "run", "--with-mocks", "--in-memory?" ],
"cwd": "${workspaceFolder}/packages/${input:service}",
"console": "integratedTerminal",
"skipFiles": [
"<node_internals>/**"
]
"skipFiles": ["<node_internals>/**"]
}
],
"inputs": [
@@ -61,4 +34,4 @@
"default": "bookshop"
}
]
}
}

View File

@@ -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-week3-unit5
git clone https://github.com/sap-samples/cloud-cap-samples projects/cloud-cap-samples -b openSAP-week2-unit3
cd projects/cloud-cap-samples
```
@@ -25,87 +25,11 @@ npm install
Now you're ready to run the samples, for example:
```sh
cd packages/bookshop
cds deploy
cds watch
```
After that, watch out for the little popup in the lower right corner of SAP Business Application Studio that asks you to open the application in your browser.
## Hints
- If your demo user logon window does not show up: clear the browsers login data
- If your port is still in use run in your terminal:
```
> pkill node //kill running node proceses
```
## Deploy to Cloud Foundry
Clean-up the CF space in your trial account if you already used it before. Make sure that there are no services or applications deployed.
Generation of the XSUAA service configuration file xs-security.json:
```sh
cds compile srv/ --to xsuaa > xs-security.json
```
In this unit we use [MTA](https://sap.github.io/cloud-mta-build-tool/) to do the deployment to CF
```sh
npm install -g mbt
```
You can generate the MTA.yaml from CDS and do manual modifications or simply use the already generated and adapted mta.yaml in the branch and directly generate the .mtar file
#### BEGIN OPTIONAL PART
If you want to generate the MTA.YAML yourself please do the following:
- Generate the mta.yaml with the HANA dependency
```sh
cds add hana --force
cds add mta
```
- Add the path to the generated xs-security.json in the MTA.YAML
```
parameters:
path: ./xs-security.json
service:xsuaa
service-plan: application
....
```
- Add the application block in the MTA.YAML
```
############## APP #########################
- name: capire-bookshop-app
type: nodejs
path: gen/app
parameters:
memory: 256M
build-parameters:
requires:
- name: capire-bookshop-srv
requires:
- name: capire-bookshop-uaa
- name: srv-binding
group: destinations
properties:
forwardAuthToken: true
name: srv-binding
url: ~{srv-url}
```
- Make sure to use service hanatrial instead of hana in the MTA.YAML
```
parameters:
service: hanatrial
```
#### END OPTIONAL PART
Generate the .mtar file for the deployment and deploy to cloud foundry:
```sh
mbt build -t ./
cf login -a https://api.cf.eu10.hana.ondemand.com
cf deploy sap.capire-bookshop_1.0.0.mtar
```
## Get Support

View File

@@ -1,12 +0,0 @@
{
"name": "deploy",
"dependencies": {
"@sap/hdi-deploy": "^3.8.2"
},
"engines": {
"node": "^8"
},
"scripts": {
"start": "node node_modules/@sap/hdi-deploy/deploy.js"
}
}

880
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -11,7 +11,7 @@
"bookshop": "cds watch packages/bookshop"
},
"dependencies": {
"@sap/cds": "^4",
"@sap/cds": "^3",
"express": "^4"
},
"devDependencies": {

View File

@@ -1,67 +0,0 @@
{
"odata": {
"version": "v4"
},
"build": {
"target": "gen",
"tasks": [
{
"src": "db",
"for": "hana",
"options": {
"model": [
"db",
"srv"
]
}
},
{
"src": "srv",
"for": "node-cf",
"options": {
"model": [
"db",
"srv",
"app"
]
}
},
{
"src": "app",
"for": "fiori",
"options": {
"model": [
"app"
]
}
}
]
},
"auth": {
"passport": {
"strategy": "mock",
"users": {
"alice": {
"password": "123",
"ID": "alice",
"roles": [
"admin",
"authenticated-user"
],
"xs.user.attributes": {
"currency": [
"USD"
]
}
},
"bob": {
"password": "123",
"ID": "bob",
"roles": [
"authenticated-user"
]
}
}
}
}
}

View File

@@ -1,29 +0,0 @@
{
"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\"}"
}
}
]
}

View File

@@ -1,11 +0,0 @@
{
"name": "capire-bookshop-approuter",
"version": "0.0.1",
"description": "",
"dependencies": {
"@sap/approuter": "^8"
},
"scripts": {
"start": "node node_modules/@sap/approuter/approuter.js"
}
}

View File

@@ -1,22 +0,0 @@
{
"welcomeFile": "/fiori.html",
"authenticationMethod": "route",
"routes": [
{
"source": "^/.*(html|js)$",
"localDir": "."
},
{
"source": "^/sapui5/.*",
"localDir": "."
},
{
"source": "^/.*/webapp/.*",
"localDir": "."
},
{
"source": "/",
"destination": "srv-binding"
}
]
}

View File

@@ -1,12 +0,0 @@
{
"name": "deploy",
"dependencies": {
"@sap/hdi-deploy": "^3.8.2"
},
"engines": {
"node": "^12"
},
"scripts": {
"start": "node node_modules/@sap/hdi-deploy/deploy.js"
}
}

View File

@@ -11,6 +11,7 @@ entity Books : managed {
currency : Currency;
}
@cds.autoexpose
entity Authors : managed {
key ID : Integer;
name : String(111);

View File

@@ -1,136 +0,0 @@
{
"file_suffixes": {
"csv": {
"plugin_name": "com.sap.hana.di.tabledata.source"
},
"hdbafllangprocedure": {
"plugin_name": "com.sap.hana.di.afllangprocedure"
},
"hdbanalyticprivilege": {
"plugin_name": "com.sap.hana.di.analyticprivilege"
},
"hdbcalculationview": {
"plugin_name": "com.sap.hana.di.calculationview"
},
"hdbcollection": {
"plugin_name": "com.sap.hana.di.collection"
},
"hdbconstraint": {
"plugin_name": "com.sap.hana.di.constraint"
},
"hdbdropcreatetable": {
"plugin_name": "com.sap.hana.di.dropcreatetable"
},
"hdbflowgraph": {
"plugin_name": "com.sap.hana.di.flowgraph"
},
"hdbfunction": {
"plugin_name": "com.sap.hana.di.function"
},
"hdbgraphworkspace": {
"plugin_name": "com.sap.hana.di.graphworkspace"
},
"hdbhadoopmrjob": {
"plugin_name": "com.sap.hana.di.virtualfunctionpackage.hadoop"
},
"hdbindex": {
"plugin_name": "com.sap.hana.di.index"
},
"hdblibrary": {
"plugin_name": "com.sap.hana.di.library"
},
"hdbmigrationtable": {
"plugin_name": "com.sap.hana.di.table.migration"
},
"hdbprocedure": {
"plugin_name": "com.sap.hana.di.procedure"
},
"hdbprojectionview": {
"plugin_name": "com.sap.hana.di.projectionview"
},
"hdbprojectionviewconfig": {
"plugin_name": "com.sap.hana.di.projectionview.config"
},
"hdbreptask": {
"plugin_name": "com.sap.hana.di.reptask"
},
"hdbresultcache": {
"plugin_name": "com.sap.hana.di.resultcache"
},
"hdbrole": {
"plugin_name": "com.sap.hana.di.role"
},
"hdbroleconfig": {
"plugin_name": "com.sap.hana.di.role.config"
},
"hdbsearchruleset": {
"plugin_name": "com.sap.hana.di.searchruleset"
},
"hdbsequence": {
"plugin_name": "com.sap.hana.di.sequence"
},
"hdbstatistics": {
"plugin_name": "com.sap.hana.di.statistics"
},
"hdbstructuredprivilege": {
"plugin_name": "com.sap.hana.di.structuredprivilege"
},
"hdbsynonym": {
"plugin_name": "com.sap.hana.di.synonym"
},
"hdbsynonymconfig": {
"plugin_name": "com.sap.hana.di.synonym.config"
},
"hdbsystemversioning": {
"plugin_name": "com.sap.hana.di.systemversioning"
},
"hdbtable": {
"plugin_name": "com.sap.hana.di.table"
},
"hdbtabledata": {
"plugin_name": "com.sap.hana.di.tabledata"
},
"hdbtabletype": {
"plugin_name": "com.sap.hana.di.tabletype"
},
"hdbtrigger": {
"plugin_name": "com.sap.hana.di.trigger"
},
"hdbview": {
"plugin_name": "com.sap.hana.di.view"
},
"hdbvirtualfunction": {
"plugin_name": "com.sap.hana.di.virtualfunction"
},
"hdbvirtualfunctionconfig": {
"plugin_name": "com.sap.hana.di.virtualfunction.config"
},
"hdbvirtualpackagehadoop": {
"plugin_name": "com.sap.hana.di.virtualpackage.hadoop"
},
"hdbvirtualpackagesparksql": {
"plugin_name": "com.sap.hana.di.virtualpackage.sparksql"
},
"hdbvirtualprocedure": {
"plugin_name": "com.sap.hana.di.virtualprocedure"
},
"hdbvirtualprocedureconfig": {
"plugin_name": "com.sap.hana.di.virtualprocedure.config"
},
"hdbvirtualtable": {
"plugin_name": "com.sap.hana.di.virtualtable"
},
"hdbvirtualtableconfig": {
"plugin_name": "com.sap.hana.di.virtualtable.config"
},
"properties": {
"plugin_name": "com.sap.hana.di.tabledata.properties"
},
"tags": {
"plugin_name": "com.sap.hana.di.tabledata.properties"
},
"txt": {
"plugin_name": "com.sap.hana.di.copyonly"
}
}
}

View File

@@ -1,94 +0,0 @@
####### Generated mta.yaml based on template version 0.2.0
####### appName = capire-bookshop
####### language=nodejs; multiTenant=
####### approuter=
_schema-version: '3.1'
ID: sap.capire-bookshop
version: 1.0.0
description: "A simple bookshop application, build in a self-contained all-in-one fashion, i.e. w/o reusing other packages."
build-parameters:
before-all:
- builder: custom
commands:
- npm install
- cds build/all
parameters:
enable-parallel-deployments: true
modules:
############## SERVER MODULE ##########################
- name: capire-bookshop-srv
type: nodejs
path: gen/srv
properties:
EXIT: 1 # required by deploy.js task to terminate
requires:
#### Resources extracted from CAP configuration ####
- name: capire-bookshop-db
- name: capire-bookshop-uaa
provides:
- name: srv-binding # required by consumers of CAP services (e.g. approuter)
properties:
srv-url: ${default-url}
############################################################
############## SIDECAR MODULE #########################
- name: db
type: hdb
path: gen/db
parameters:
app-name: capire-bookshop-db
requires:
#### Hana and xsuaa resources extracted from CAP configuration ####
- name: capire-bookshop-db
- name: capire-bookshop-uaa
############################################################
############## APP #########################
- name: capire-bookshop-app
type: nodejs
path: gen/app
parameters:
memory: 256M
build-parameters:
requires:
- name: capire-bookshop-srv
requires:
- name: capire-bookshop-uaa
- name: srv-binding
group: destinations
properties:
forwardAuthToken: true
name: srv-binding
url: ~{srv-url}
############## RESOURCES ##################################
resources:
##### Services extracted from CAP configuration ####
##### 'service-plan' can be configured via 'cds.requires.<name>.vcap.plan'
- name: capire-bookshop-db
type: com.sap.xs.hdi-container
parameters:
service: hanatrial
properties:
hdi-service-name: ${service-name} # required for Java case
- name: capire-bookshop-uaa
type: org.cloudfoundry.managed-service
parameters:
##### Path to xs-security.json to add roles and scopes ####
path: ./xs-security.json
service: xsuaa
service-plan: application
config:
xsappname: capire-bookshop-${space} # name + space dependency
tenant-mode: dedicated
############################################################

View File

@@ -1,29 +1,21 @@
{
"name": "@sap/capire-bookshop",
"version": "1.0.0",
"description": "A simple bookshop application, build in a self-contained all-in-one fashion, i.e. w/o reusing other packages.",
"license": "SAP SAMPLE CODE LICENSE",
"dependencies": {
"@sap/cds": "^4",
"express": "^4",
"hdb": "^0.18.1",
"passport": "^0.4.1"
},
"scripts": {
"start": "cds run --in-memory?",
"watch": "cds watch"
},
"cds": {
"requires": {
"db": {
"kind": "sql",
"[production]": {
"kind": "hana"
}
},
"uaa": {
"kind": "xsuaa"
}
}
"name": "@sap/capire-bookshop",
"version": "1.0.0",
"description": "A simple bookshop application, build in a self-contained all-in-one fashion, i.e. w/o reusing other packages.",
"license": "SAP SAMPLE CODE LICENSE",
"dependencies": {
"@sap/cds": "^3",
"express": "^4"
},
"scripts": {
"start": "cds run --in-memory?",
"watch": "cds watch"
},
"cds": {
"requires": {
"db": {
"kind": "sql"
}
}
}
}
}

Binary file not shown.

View File

@@ -1,6 +1,6 @@
using { sap.capire.bookshop as my } from '../db/schema';
service AdminService @(_requires:'authenticated-user') {
service AdminService @(_requires:'authenticated-user',path:'/admin') {
entity Books as projection on my.Books;
entity Authors as projection on my.Authors;
entity Orders as select from my.Orders;
@@ -10,11 +10,7 @@ service AdminService @(_requires:'authenticated-user') {
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;
}
// Restrict access to orders to users with role "admin"
annotate AdminService.Orders with @(restrict: [
{ grant: 'READ', to: 'admin' }
]);

View File

@@ -1,10 +0,0 @@
/** Service implementation for AdminService */
module.exports = cds.service.impl(function() {
this.before ('CREATE', 'Orders', _checkOrderCreateAuth)
})
/** Check authorization */
function _checkOrderCreateAuth (req) {
req.user.currency[0] === req.data.currency_code || req.reject(403)
}

View File

@@ -3,15 +3,9 @@ using { sap.capire.bookshop as my } from '../db/schema';
@path:'/browse'
service CatalogService {
@readonly entity Books as SELECT from my.Books {*,
author.name as author
} excluding { createdBy, modifiedBy };
@readonly entity Books as SELECT from my.Books { * } excluding { createdBy, modifiedBy };
@requires_: 'authenticated-user'
entity Orders as projection on my.Orders;
@insertonly entity Orders as projection on my.Orders;
}
// Example for an instance restriction
annotate CatalogService.Orders with @(restrict: [
{ grant: 'READ', where: 'currency_code = $user.currency' }
]);

View File

@@ -14,20 +14,13 @@ function _addDiscount2 (each,discount) {
/** Reduce stock of ordered books if available stock suffices */
async function _reduceStock (req) {
const { Items: orderItems } = req.data
if (!Array.isArray(orderItems)) return
const all = await cds.transaction(req).run(orderItems.map(item =>
UPDATE(Books)
.set('stock -=', item.amount)
.where('ID =', item.book_ID).and('stock >=', item.amount)
))
all.forEach((affectedRows, i) => {
if (affectedRows === 0) {
req.error(409, `${orderItems[i].amount} exceeds stock for book #${orderItems[i].book_ID}`)
}
})
return all
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}`
)
}))
}

View File

@@ -1,18 +1,14 @@
### Service Document
GET http://localhost:4004/browse
### Browse Books
GET http://localhost:4004/browse/Books
### Service $metadata document
GET http://localhost:4004/browse/$metadata
### Browse Books with expanded Authors
GET http://localhost:4004/browse/Books?$expand=author
### Browsing Books
GET http://localhost:4004/browse/Books?
# &$select=title,author
# &$expand=currency
# &sap-language=de
### Try to insert into Books
POST http://localhost:4004/browse/Books
Content-Type: application/json
### Browsing Authors
GET http://localhost:4004/admin/Authors?
# &$select=name,dateOfBirth,placeOfBirth
# &$expand=books($select=title;$expand=currency)
# &$filter=ID eq 101
# &sap-language=de
{
"title": "Anna Karenina",
"stock": 10
}

View File

@@ -1,18 +1,15 @@
### List Books with their current stocks
GET http://localhost:4004/admin/Books?$select=ID,stock
### List all Orders
### List all Orders - deep read
GET http://localhost:4004/admin/Orders?
&$expand=Items
### Submit Orders
### Submit Orders - deep insert
POST http://localhost:4004/browse/Orders
Content-Type: application/json
{ "OrderNo":"2019-09...", "Items":[
{ "OrderNo":"1234", "Items":[
{ "book_ID":201, "amount":5 },
{ "book_ID":207, "amount":3 }
]}
# Sending this three times should result in a 409: 5 exceeds stock for book #201
### Try to get the Orders
GET http://localhost:4004/browse/Orders

View File

@@ -1,37 +0,0 @@
{
"xsappname": "capire-bookshop",
"tenant-mode": "dedicated",
"scopes": [
{
"name": "$XSAPPNAME.admin",
"description": "admin"
}
],
"attributes": [
{
"name": "currency",
"description": "currency",
"valueType": "s",
"valueRequired": false
}
],
"role-templates": [
{
"name": "admin",
"description": "generated",
"scope-references": [
"$XSAPPNAME.admin"
],
"attribute-references": []
},
{
"name": "userattributes",
"description": "generated",
"default-role-name": "Attributes of a User",
"scope-references": [],
"attribute-references": [
"currency"
]
}
]
}