Merge pull request #95 from serlo/development

Staging deployment

.env.local.template

@@ -0,0 +1,27 @@
+# Template - Copy content to `.env` file and add missing (secret) values
+
+# Set this to 'local' in local development.
+# - sets origin to localhost
+# - configures cookie handling
+ENVIRONMENT=local
+
+EDITOR_URL=http://localhost:3000/
+
+# Secret to enable media upload
+SERLO_EDITOR_TESTING_SECRET=
+
+# Symmetric HS256 key used by ltijs to sign ltik and database entries & to sign the jwt access token
+LTIJS_KEY=DONOTUSETHISKEYINPRODUCTION
+
+MYSQL_URI=mysql://root:secret@mariadb:3306/serlo
+
+# https://www.mongodb.com/docs/drivers/go/current/fundamentals/connections/connection-guide/#connection-uri
+MONGODB_URI=mongodb://mongo:27017/
+
+# LTI platform: https://saltire.lti.app/platform
+ALLOW_SALTIRE=true
+
+# LTI platform: edu-sharing mock
+ALLOW_EDUSHARING_MOCK=true
+
+# Keep an empty line at the end

.env.uberspace.edtr.template

@@ -0,0 +1,31 @@
+# Template - Copy content to `.env` file and add missing (secret) values
+
+EDITOR_URL=https://edtr.uber.space/
+
+# Secret to enable media upload
+SERLO_EDITOR_TESTING_SECRET=
+
+# Symmetric HS256 key used by ltijs to sign ltik and database entries & to sign the jwt access token
+LTIJS_KEY=
+
+# LTI platform: itslearning
+ITSLEARNING_URL=
+ITSLEARNING_NAME=
+SERLO_EDITOR_CLIENT_ID_ON_ITSLEARNING=
+ITSLEARNING_AUTHENTICATION_ENDPOINT=
+ITSLEARNING_ACCESS_TOKEN_ENDPOINT=
+ITSLEARNING_KEYSET_ENDPOINT=
+
+# LTI platform: edu-sharing (RLP)
+EDUSHARING_RLP_URL=
+EDUSHARING_RLP_NAME=
+SERLO_EDITOR_CLIENT_ID_ON_EDUSHARING_RLP=
+EDUSHARING_RLP_AUTHENTICATION_ENDPOINT=
+EDUSHARING_RLP_ACCESS_TOKEN_ENDPOINT=
+EDUSHARING_RLP_KEYSET_ENDPOINT=
+
+# LTI tool: edu-sharing (RLP)
+EDUSHARING_RLP_LOGIN_ENDPOINT=
+EDUSHARING_RLP_LAUNCH_ENDPOINT=
+EDUSHARING_RLP_CLIENT_ID_ON_SERLO_EDITOR=
+EDUSHARING_RLP_DETAILS_ENDPOINT=

.env.uberspace.edtrdev.template

@@ -0,0 +1,12 @@
+# Template - Copy content to `.env` file and add missing (secret) values
+
+EDITOR_URL=https://edtrdev.uber.space/
+
+# Secret to enable media upload
+SERLO_EDITOR_TESTING_SECRET=
+
+# Symmetric HS256 key used by ltijs to sign ltik and database entries & to sign the jwt access token
+LTIJS_KEY=DONOTUSETHISKEYINPRODUCTION
+
+# LTI platform: https://saltire.lti.app/platform
+ALLOW_SALTIRE=true

.env.uberspace.edtrstag.template

@@ -0,0 +1,34 @@
+# Template - Copy content to `.env` file and add missing (secret) values
+
+EDITOR_URL=https://edtrstag.uber.space/
+
+# Secret to enable media upload
+SERLO_EDITOR_TESTING_SECRET=
+
+# Symmetric HS256 key used by ltijs to sign ltik and database entries & to sign the jwt access token
+LTIJS_KEY=DONOTUSETHISKEYINPRODUCTION
+
+# LTI platform: https://saltire.lti.app/platform
+ALLOW_SALTIRE=true
+
+# LTI platform: itslearning (staging)
+ITSLEARNING_URL=
+ITSLEARNING_NAME=
+SERLO_EDITOR_CLIENT_ID_ON_ITSLEARNING=
+ITSLEARNING_AUTHENTICATION_ENDPOINT=
+ITSLEARNING_ACCESS_TOKEN_ENDPOINT=
+ITSLEARNING_KEYSET_ENDPOINT=
+
+# LTI platform: edu-sharing (RLP) (staging)
+EDUSHARING_RLP_URL=
+EDUSHARING_RLP_NAME=
+SERLO_EDITOR_CLIENT_ID_ON_EDUSHARING_RLP=
+EDUSHARING_RLP_AUTHENTICATION_ENDPOINT=
+EDUSHARING_RLP_ACCESS_TOKEN_ENDPOINT=
+EDUSHARING_RLP_KEYSET_ENDPOINT=
+
+# LTI tool: edu-sharing (RLP) (staging)
+EDUSHARING_RLP_LOGIN_ENDPOINT=
+EDUSHARING_RLP_LAUNCH_ENDPOINT=
+EDUSHARING_RLP_CLIENT_ID_ON_SERLO_EDITOR=
+EDUSHARING_RLP_DETAILS_ENDPOINT=

.github/workflows/checks.yml

@@ -27,3 +27,24 @@ jobs:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/setup-node
       - run: yarn lint:tsc
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup-node
+      - run: yarn build
+
+  # TODO: this is just a basic check to see if it is set up and running
+  # change for real tests later
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup-node
+      - run: cp .env.local.template .env
+      - run: yarn dev -d
+      - run: yarn build
+      - run: sleep 15
+      - run: yarn playwright install
+      - run: HEADLESS=true yarn test

.github/workflows/deploy.yml

@@ -0,0 +1,43 @@
+name: Deploy to Uberspace
+
+on:
+  push:
+    branches:
+      - staging
+      - development
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set environment variables for development
+        if: ${{ github.ref_name == 'development' }}
+        run: |
+          echo "REMOTE_HOST=${{ secrets.REMOTE_HOST_DEV }}" >> $GITHUB_ENV
+          echo "REMOTE_USER=${{ secrets.REMOTE_USER_DEV }}" >> $GITHUB_ENV
+          echo "DOMAIN=https://editor.serlo.dev/" >> $GITHUB_ENV
+
+      - name: Set environment variables for staging
+        if: ${{ github.ref_name == 'staging' }}
+        run: |
+          echo "REMOTE_HOST=${{ secrets.REMOTE_HOST_STAGING }}" >> $GITHUB_ENV
+          echo "REMOTE_USER=${{ secrets.REMOTE_USER_STAGING }}" >> $GITHUB_ENV
+          echo "DOMAIN=https://editor.serlo-staging.dev/" >> $GITHUB_ENV
+
+      - name: Deploy to Server
+        uses: appleboy/[email protected]
+        with:
+          host: ${{  env.REMOTE_HOST }}
+          username: ${{ env.REMOTE_USER }}
+          key: ${{ secrets.SSH_PRIVATE_KEY }}
+          script: |
+            cd /home/${{ env.REMOTE_USER }}/serlo-editor-as-lti-tool/
+            git checkout --force ${{ github.ref_name }}
+            git pull
+            yarn
+            yarn build
+            supervisorctl restart serlo-app
+
+      - name: Test deployment successful
+        run: sleep 2 && curl ${{ env.DOMAIN }} | grep NO_LTIK_OR_IDTOKEN_FOUND

.gitignore

@@ -1,4 +1,7 @@
-# .env - Should not be added because it contains private keys used for encryption
+# output folder of e2e tests
+output
+
+# .env - Should not be added because they might contain secrets
 .env
 
 # Logs

Dockerfile

@@ -0,0 +1,17 @@
+FROM node:20.18.0 as build
+WORKDIR /usr/src/app
+
+COPY . .
+RUN yarn install --immutable
+
+RUN yarn build
+
+FROM node:20.18.0 as production
+
+WORKDIR /usr/src/app
+
+COPY --from=build /usr/src/app/dist dist
+
+EXPOSE 3000
+
+ENTRYPOINT ["node", "dist/backend/index.cjs"]

Dockerfile.dev

@@ -1,15 +1,13 @@
 # syntax=docker/dockerfile:1
 
-FROM node:20.17.0
+FROM node:20.18.0
 WORKDIR /usr/src/app
 
-RUN apt update && apt install neovim nano -y
-
 COPY . .
 RUN yarn install --immutable
 
 RUN yarn build
 
 EXPOSE 3000
 
-ENTRYPOINT ["yarn", "start:dev"]
+ENTRYPOINT ["yarn", "start"]

README.md

@@ -1,24 +1,34 @@
-Serlo editor as LTI tool Status: Early prototype
+Prototype: Serlo editor as LTI tool
 
 # Local dev setup
 
 Requirements:
 
-- Docker & Docker Compose
+- Docker 26.0.0 or later
 
-1. Create file `.env` and copy content from `.env-template`
-2. `yarn` to install dependencies
-3. `yarn dev` to start docker containers (hot reload)
-4. Go to https://saltire.lti.app/platform, sign in, navigate to "Advanced
+1. Create a copy of `.env.local.template` as `.env`
+2. (optional) Add secret values to `.env`
+3. `yarn` to install dependencies
+4. `yarn dev` to start docker containers
+
+Now, the editor is running locally. It will automatically restart when files get
+modified.
+
+## Launch through Saltire
+
+1. Go to https://saltire.lti.app/platform, sign in, navigate to "Advanced
    options" and upload file `saltire-platform_[TYPE].config` of the
    [`saltire-configs/`](./saltire-configs) directory. `TYPE=LTIDeepLinking`
    shows flow of creating a new Serlo Editor element.
    `TYPE=LTIResourceLink_Instructor` shows flow of opening an existing Serlo
    Editor element as Instructor (editable). `TYPE=LTIResourceLink_Learner` shows
    flow of opening an existing Serlo Editor element as Learner (non-editable).
-5. Click "Connect"
+2. Click "Connect"
+
+## Launch through edu-sharing mock
 
-The editor should open in a new tab.
+1. `yarn dev:edusharing` to start the edu-sharing mock
+2. Open `http://localhost:8100`
 
 # Technical details
 

codecept.conf.ts

@@ -0,0 +1,22 @@
+import { setHeadlessWhen, setCommonPlugins } from '@codeceptjs/configure'
+
+setHeadlessWhen(process.env.HEADLESS)
+
+// enable all common plugins https://github.com/codeceptjs/configure#setcommonplugins
+setCommonPlugins()
+
+export const config: CodeceptJS.MainConfig = {
+  tests: 'e2e/tests/**/*.ts',
+  output: './output',
+  helpers: {
+    Playwright: {
+      browser: 'chromium',
+      url: 'http://localhost:3000',
+      show: true,
+    },
+  },
+  include: {
+    I: './e2e/steps_file',
+  },
+  name: 'serlo-editor-as-lti-tool',
+}