plugins: added initial mock-idp-backend

plugins/mock-idp-backend/.eslintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: [require.resolve('@backstage/cli/config/eslint.backend')],
+};

plugins/mock-idp-backend/README.md

@@ -0,0 +1,7 @@
+# Mock IdP Backend
+
+Mock backend for demonstrating 3rd party identity provider flow with SAML 2.0.
+
+## Links
+
+- (The Backstage homepage)[https://backstage.io]

plugins/mock-idp-backend/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@backstage/plugin-mock-idp-backend",
+  "version": "0.1.1-alpha.6",
+  "main": "dist",
+  "types": "src/index.ts",
+  "license": "Apache-2.0",
+  "private": true,
+  "scripts": {
+    "start": "tsc-watch --onFirstSuccess \"cross-env NODE_ENV=development nodemon dist/run.js\"",
+    "build": "tsc",
+    "lint": "backstage-cli lint",
+    "test": "backstage-cli test",
+    "prepack": "backstage-cli prepack",
+    "postpack": "backstage-cli postpack",
+    "clean": "backstage-cli clean"
+  },
+  "dependencies": {
+    "@backstage/backend-common": "^0.1.1-alpha.6",
+    "compression": "^1.7.4",
+    "cors": "^2.8.5",
+    "express": "^4.17.1",
+    "express-promise-router": "^3.0.3",
+    "fs-extra": "^9.0.0",
+    "helmet": "^3.22.0",
+    "morgan": "^1.10.0",
+    "winston": "^3.2.1",
+    "yn": "^4.0.0"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.1.1-alpha.6",
+    "@types/supertest": "^2.0.8",
+    "supertest": "^4.0.2",
+    "tsc-watch": "^4.2.3"
+  },
+  "files": [
+    "dist"
+  ],
+  "nodemonConfig": {
+    "watch": "./dist"
+  }
+}

plugins/mock-idp-backend/src/index.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export * from './service/router';

plugins/mock-idp-backend/src/run.ts

@@ -0,0 +1,80 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  errorHandler,
+  getRootLogger,
+  notFoundHandler,
+  requestLoggingHandler,
+} from '@backstage/backend-common';
+import compression from 'compression';
+import cors from 'cors';
+import express from 'express';
+import helmet from 'helmet';
+import { Server } from 'http';
+import { Logger } from 'winston';
+import { createRouter } from './service';
+
+export type ServerConfig = {
+  port: number;
+  logger: Logger;
+};
+
+function readConfig() {
+  const port = Number(process.env.PLUGIN_PORT) || 3003;
+  const logger = getRootLogger().child({ service: 'mock-idp-backend' });
+  return { port, logger };
+}
+
+async function startStandaloneServer(config: ServerConfig): Promise<Server> {
+  const { port, logger } = config;
+  logger.debug('Creating application...');
+
+  const app = express();
+
+  app.use(helmet());
+  app.use(cors());
+  app.use(compression());
+  app.use(express.json());
+  app.use(requestLoggingHandler());
+  app.use(await createRouter({ logger }));
+  app.use(notFoundHandler());
+  app.use(errorHandler());
+
+  logger.debug('Starting application server...');
+
+  process.on('SIGINT', () => {
+    logger.info('CTRL+C pressed; exiting.');
+    process.exit(0);
+  });
+
+  return await new Promise((resolve, reject) => {
+    const server = app.listen(port, (err?: Error) => {
+      if (err) {
+        reject(err);
+        return;
+      }
+
+      logger.info(`Listening on port ${port}`);
+      resolve(server);
+    });
+  });
+}
+
+startStandaloneServer(readConfig()).catch(err => {
+  console.error(err.stack || err);
+  process.exit(1);
+});

plugins/mock-idp-backend/src/service/index.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export { createRouter } from './router';

plugins/mock-idp-backend/src/service/router.test.ts

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { getVoidLogger } from '@backstage/backend-common';
+import { createRouter } from './router';
+import express from 'express';
+import request from 'supertest';
+
+async function makeApp() {
+  const router = await createRouter({ logger: getVoidLogger() });
+  const app = express();
+  app.use(router);
+  return app;
+}
+
+describe('router', () => {
+  it('should echo', async () => {
+    const app = await makeApp();
+    const response = await request(app).get('/echo');
+    expect(response.status).toEqual(200);
+    expect(response.text).toEqual('echo');
+  });
+});

plugins/mock-idp-backend/src/service/router.ts

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import Router from 'express-promise-router';
+import { Logger } from 'winston';
+
+export interface RouterOptions {
+  logger: Logger;
+}
+
+export async function createRouter(options: RouterOptions) {
+  const { logger } = options;
+  const router = Router();
+
+  router.get('/echo', (_req, res) => {
+    logger.info('sending echo');
+    res.send('echo');
+  });
+
+  return router;
+}

plugins/mock-idp-backend/src/setupTests.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2020 Spotify AB
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export {};

plugins/mock-idp-backend/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "include": ["src"],
+  "compilerOptions": {
+    "outDir": "dist",
+    "incremental": true,
+    "sourceMap": true,
+    "declaration": true,
+    "strict": true,
+    "target": "es2019",
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "lib": ["es2019"],
+    "types": ["node", "jest"]
+  }
+}