@newskit-render/mock 0.0.0-014af081

package/Dockerfile

@@ -0,0 +1,14 @@
+FROM node:18.17-buster
+
+WORKDIR /app
+
+COPY node_modules ./node_modules
+COPY package.json ./package.json
+COPY json-server.json ./json-server.json
+COPY routes.json ./routes.json
+COPY singular.js ./singular.js
+COPY src ./src
+
+EXPOSE 3000
+
+ENTRYPOINT ["node", "./node_modules/.bin/json-server", "src/index.js"]

package/README.md

@@ -0,0 +1,25 @@
+# @newskit-render/mock
+
+Mock Rest API for our NewsKit Render Demo Site
+
+## Usage
+
+use `json-server` to create two endpoint:
+
+- articles
+- pages
+
+Start server with - `yarn start`  
+Go to - http://localhost:4000 to see your endpoints
+
+http://localhost:4000/articles  
+http://localhost:4000/page
+
+There are 10 articles you can filter from (1 to 10)  
+http://localhost:4000/articles/demo-1   
+http://localhost:4000/articles/demo-10   
+
+There are 3 pages you can filter  
+http://localhost:4000/pages/homepage  
+http://localhost:4000/pages/section-one  
+http://localhost:4000/pages/section-two  

package/helm/Chart.yaml

@@ -0,0 +1,21 @@
+apiVersion: v2
+name: ncu-newskit-render-mock
+description: A NewsKit Render Helm chart for Kubernetes
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+version: 0.1.0
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application.
+appVersion: 0.0.1

package/helm/templates/NOTES.txt

@@ -0,0 +1 @@
+

package/helm/templates/_helpers.tpl

@@ -0,0 +1,54 @@
+{{/* vim: set filetype=mustache: */}}
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "mock.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "mock.fullname" -}}
+{{- if .Values.fullnameOverride -}}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- $name := default .Chart.Name .Values.nameOverride -}}
+{{- if contains $name .Release.Name -}}
+{{- .Release.Name | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "mock.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Labels
+*/}}
+{{- define "mock.labels" -}}
+{{ include "mock.selectors" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+news.co.uk/service-catalogue-id: {{ .Values.tags.serviceCatalogueId | quote }}
+news.co.uk/service-name: {{ .Values.tags.serviceName }}
+news.co.uk/environment: {{ .Values.environment }}
+{{- end -}}
+
+{{/*
+Selector labels
+*/}}
+{{- define "mock.selectors" -}}
+app.kubernetes.io/name: {{ include "mock.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end -}}

package/helm/templates/deployment.yaml

@@ -0,0 +1,31 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "mock.fullname" . }}
+  namespace: {{ .Values.namespace }}
+  labels: {{ include "mock.labels" . | nindent 4 }}
+spec:
+  replicas: {{ .Values.replicaCount }}
+  revisionHistoryLimit: {{ .Values.revisionHistoryLimit }}
+  selector:
+    matchLabels:  {{ include "mock.selectors" . | nindent 6 }}
+  template:
+    metadata:
+      annotations:
+        {{- if eq .Values.environment "pr" }}
+        rollme: {{ randAlphaNum 5 }}
+        {{- end }}
+      labels: {{ include "mock.selectors" . | nindent 8 }}
+    spec:
+      imagePullSecrets: {{ toYaml .Values.imagePullSecrets | nindent 8 }}
+      containers:
+        - name: {{ .Chart.Name }}
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          ports:
+            - name: http
+              containerPort: {{ .Values.service.port }}
+              protocol: TCP
+          readinessProbe: {{ toYaml .Values.readinessProbe | nindent 12 }}
+          livenessProbe: {{ toYaml .Values.livenessProbe | nindent 12 }}
+          resources: {{ toYaml .Values.resources | nindent 12 }}

package/helm/templates/horizontalpodautoscaler.yaml

@@ -0,0 +1,20 @@
+apiVersion: autoscaling/v2
+kind: HorizontalPodAutoscaler
+metadata:
+  name: {{ include "mock.fullname" . }}-hpa
+  namespace: {{ .Values.namespace }}
+  labels: {{ include "mock.labels" . | nindent 4 }}
+spec:
+  scaleTargetRef:
+    apiVersion: apps/v1
+    kind: Deployment
+    name: {{ include "mock.fullname" . }}
+  minReplicas: {{ .Values.horizontalAutoScale.min }}
+  maxReplicas: {{ .Values.horizontalAutoScale.max }}
+  metrics:
+  - type: Resource
+    resource:
+      name: {{ .Values.horizontalAutoScale.resource }}
+      target:
+        type: Utilization
+        averageUtilization: {{ .Values.horizontalAutoScale.utilization }}

package/helm/templates/networkpolicy.yaml

@@ -0,0 +1,25 @@
+{{- if .Values.networkpolicy.enabled -}}
+{{- $fullName := include "mock.fullname" . -}}
+apiVersion: networking.k8s.io/v1
+kind: NetworkPolicy
+metadata:
+  name: {{ $fullName }}-allowed-traffic
+  namespace: {{ .Values.namespace }}
+  annotations: {{ include "mock.labels" . | nindent 4 }}
+spec:
+  podSelector:
+    matchExpressions :
+      - key: app.kubernetes.io/name
+        operator: In
+        values:
+          - {{ include "mock.name" . }}
+  ingress:
+    - ports:
+      - port: {{ .Values.service.port }}
+        protocol: TCP
+  egress:
+    - {}
+  policyTypes:
+    - Ingress
+    - Egress
+{{- end }}

package/helm/templates/service.yaml

@@ -0,0 +1,14 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "mock.fullname" . }}
+  namespace: {{ .Values.namespace }}
+  labels: {{ include "mock.labels" . | nindent 4 }}
+spec:
+  type: {{ .Values.service.type }}
+  ports:
+    - port: {{ .Values.service.port }}
+      targetPort: {{ .Values.service.port }}
+      protocol: TCP
+      name: http
+  selector: {{ include "mock.selectors" . | nindent 4 }}

package/helm/values-dev.yaml

@@ -0,0 +1,23 @@
+# Default values for NewsKit Render.
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+namespace: newskit-render-dev
+
+replicaCount: 1
+revisionHistoryLimit: 3
+
+resources:
+  limits:
+    cpu: 1
+    memory: 512Mi
+  requests:
+    cpu: 200m
+    memory: 256Mi
+
+environment: dev
+
+horizontalAutoScale:
+  min: 1
+  max: 2
+  resource: cpu
+  utilization: 60

package/helm/values-local.yaml

@@ -0,0 +1,26 @@
+# Default values for NewsKit Render.
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+namespace: newskit-render-local
+
+replicaCount: 1
+revisionHistoryLimit: 3
+
+imagePullSecrets:
+  - name: regcred
+
+resources:
+  limits:
+    cpu: 1
+    memory: 512Mi
+  requests:
+    cpu: 200m
+    memory: 256Mi
+
+environment: local
+
+horizontalAutoScale:
+  min: 1
+  max: 2
+  resource: cpu
+  utilization: 60

package/helm/values-pr.yaml

@@ -0,0 +1,23 @@
+# Default values for NewsKit Render.
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+namespace: newskit-render-pr
+
+replicaCount: 1
+revisionHistoryLimit: 3
+
+resources:
+  limits:
+    cpu: 1
+    memory: 512Mi
+  requests:
+    cpu: 200m
+    memory: 256Mi
+
+environment: pr
+
+horizontalAutoScale:
+  min: 1
+  max: 2
+  resource: cpu
+  utilization: 60

package/helm/values-prod.yaml

@@ -0,0 +1,23 @@
+# Default values for NewsKit Render.
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+namespace: newskit-render-prod
+
+replicaCount: 2
+revisionHistoryLimit: 5
+
+resources:
+  limits:
+    cpu: 1
+    memory: 512Mi
+  requests:
+    cpu: 200m
+    memory: 256Mi
+
+environment: prod
+
+horizontalAutoScale:
+  min: 2
+  max: 4
+  resource: cpu
+  utilization: 60

package/helm/values-staging.yaml

@@ -0,0 +1,23 @@
+# Default values for NewsKit Render.
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+namespace: newskit-render-staging
+
+replicaCount: 2
+revisionHistoryLimit: 5
+
+resources:
+  limits:
+    cpu: 1
+    memory: 512Mi
+  requests:
+    cpu: 200m
+    memory: 256Mi
+
+environment: staging
+
+horizontalAutoScale:
+  min: 2
+  max: 4
+  resource: cpu
+  utilization: 60

package/helm/values.yaml

@@ -0,0 +1,37 @@
+image:
+  repository: 940731442544.dkr.ecr.eu-west-1.amazonaws.com/ncu-newskit-render-mock
+  tag: ""
+  pullPolicy: Always
+
+imagePullSecrets: []
+nameOverride: ""
+fullnameOverride: ""
+
+service:
+  type: NodePort
+  port: 3000
+
+tags:
+  serviceCatalogueId: 482
+  serviceName: newskit-render
+
+networkpolicy:
+  enabled: true
+  annotations: {}
+
+# Health check endpoint
+readinessProbe:
+  httpGet:
+    path: /
+    port: 3000
+  initialDelaySeconds: 5
+  periodSeconds: 1
+
+livenessProbe:
+  httpGet:
+    path: /
+    port: 3000
+  initialDelaySeconds: 5
+  timeoutSeconds: 2
+  periodSeconds: 3
+  failureThreshold: 5

package/json-server.json

@@ -0,0 +1,5 @@
+{
+  "host": "0.0.0.0",
+  "routes": "routes.json",
+  "middlewares": "./singular.js"
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@newskit-render/mock",
+  "version": "0.0.0-014af081",
+  "description": "Simple rest api with mock data",
+  "author": "",
+  "license": "UNLICENSED",
+  "engines": {
+    "node": ">=16.13"
+  },
+  "scripts": {
+    "start": "json-server --watch src/index.js --port 4000",
+    "clean": "rm -rf node_modules & rm -f package-lock.json & rm -f yarn.lock"
+  },
+  "dependencies": {
+    "json-server": "0.17.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/release-documentation-cli.config.json

@@ -0,0 +1,18 @@
+{
+  "gitConfigPath": "../../.git/config",
+  "releaseDetails": {
+    "emailAddress": "newskit-render@news.co.uk",
+    "title": "NewsKit Render - Mock Service",
+    "platform": "Web",
+    "osType": "AWS",
+    "partner": "Internal (NewsUK Teams)",
+    "priority": "P2 - Very Important release required (3-4 days)",
+    "businessJustification": "This release is to deliver performance improvements, feature enhancements and bug fixes for NewsKit Render",
+    "testingMethod": "Both",
+    "testingToolsUsed": "Jest",
+    "releaseDurationMinutes": 15,
+    "appIds": ["NUK482"],
+    "environment": "Production"
+  },
+  "localChangelogPath": "./CHANGELOG.md"
+}

package/routes.json

@@ -0,0 +1,3 @@
+{
+  "/pages/:slug": "/page?data.attributes.slug=:slug&singular=1"
+}

package/singular.js

@@ -0,0 +1,19 @@
+module.exports = (req, res, next) => {
+  const _send = res.send;
+  res.send = function (body) {
+    if (require("url").parse(req.originalUrl, true).query["singular"]) {
+      try {
+        const json = JSON.parse(body);
+        if (Array.isArray(json)) {
+          if (json.length === 1) {
+            return _send.call(this, JSON.stringify(json[0]));
+          } else if (json.length === 0) {
+            return _send.call(this, "{}", 404);
+          }
+        }
+      } catch (e) {}
+    }
+    return _send.call(this, body);
+  };
+  next();
+};