Test pull request

.dockerignore

@@ -0,0 +1,2 @@
+dist/
+node_modules/

.eslintrc.js

@@ -1,6 +1,6 @@
 module.exports = {
   "env": {
-    "browser": true,
+    "node": true,
     "es6": true,
     "jest/globals": true
   },

.github/workflows/hello.yml

@@ -0,0 +1,17 @@
+name: Hello World!
+
+on:
+    push: 
+        branches: 
+            - master
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - name: Hello World!
+              run: echo "Hello World!"
+            - name: Date
+              run: date
+            - name: Files
+              run: ls -l

.github/workflows/pipeline.yml

@@ -0,0 +1,37 @@
+name: Deployment pipeline
+
+on:
+  push: # runs on every push to master
+    branches: 
+      - master
+  pull_request: 
+      branches: [master]
+      types: [opened, synchronize] # he workflow will run when a PR into the main branch is opened or updated.
+jobs: 
+    simple_deployment_pipeline:
+        runs-on: ubuntu-20.04 # the type of machine to run the job on. What do is run the job on a ubuntu machine.
+        steps: 
+            - uses : actions/checkout@v3  # this is a github action that checks out the code from the repo. This makes the code available to the job.
+            - uses: superfly/flyctl-actions/setup-flyctl@master # Installs the flyctl CLI tool to enable deploying and managing Fly apps
+            - uses : actions/setup-node@v3 # this is a github action that sets up node on the machine. This makes node available to the job.
+              with: 
+                node-version: '16' # this is the version of node to install on the machine.
+            - name: Install dependencies # this is a step that installs the dependencies of the project.
+              run: npm install
+            - name: Check code formatting # this is a step that checks the code formatting.
+              run: npm run eslint
+            - name: Tests # this is a step that runs the tests.
+              run: npm run test
+            - name: Build # this is a step that builds the project.
+              run: npm run build
+            - name: e2e tests # this is a step that runs the end to end tests.
+              uses: cypress-io/github-action@v5
+              with: 
+                command: npm run test:e2e
+                start: npm run start-prod
+                wait-on: http://localhost:8080
+            - name: Deploy
+              if: ${{ github.event_name == 'push' }}
+              run: flyctl deploy --remote-only
+              env: 
+                FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}

Dockerfile

@@ -0,0 +1,45 @@
+# syntax = docker/dockerfile:1
+
+# Adjust NODE_VERSION as desired
+ARG NODE_VERSION=16.20.2
+FROM node:${NODE_VERSION}-slim as base
+
+LABEL fly_launch_runtime="Node.js"
+
+# Node.js app lives here
+WORKDIR /app
+
+# Set production environment
+ENV NODE_ENV="production"
+
+
+# Throw-away build stage to reduce size of final image
+FROM base as build
+
+# Install packages needed to build node modules
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y build-essential node-gyp pkg-config python
+
+# Install node modules
+COPY --link package-lock.json package.json ./
+RUN npm ci --include=dev
+
+# Copy application code
+COPY --link . .
+
+# Build application
+RUN npm run build
+
+# Remove development dependencies
+RUN npm prune --omit=dev
+
+
+# Final stage for app image
+FROM base
+
+# Copy built application
+COPY --from=build /app /app
+
+# Start the server by default, this can be overwritten at runtime
+EXPOSE 3000
+CMD [ "npm", "run", "start" ]

README.md

@@ -4,6 +4,16 @@ This repository is used for the CI/CD module of the Full stack open course
 
 Fork the repository to complete course exercises
 
+### Some common steps in a CI setup include linting, testing, and building. What are the specific tools for taking care of these steps in the ecosystem of the language you picked?
+In python, for linting: "flake8" or "pylint". In testing, pytest or unittest. Building: "setuptools" or "wheel"
+
+### What alternatives are there to set up the CI besides Jenkins and GitHub Actions? 
+Buddy, a faster, simpler, and more reliable Jenkins alternative. Also others like: Azure pipelines, Bamboo by Atlassian, gitlab CI/CD.
+
+### Would this setup be better in a self-hosted or a cloud-based environment? Why? What information would you need to make that decision?
+Depends on the project and complexity, on a large and robust infrastructure, the more situable solution would be a self-hosted one. Otherwise,
+for a more small, personal project, the less configuration the better, so, cloud-based solution. Also, even between languages, there's not seem
+much difference on the linting, building and testing, just tools and probably some configuration, but the process concept may keep the same.
 ## Commands
 
 Start by running `npm install` inside the project folder

app.js

@@ -1,11 +1,21 @@
-const express = require("express");
-const app = express();
+const express = require('express')
+const app = express()
 
 // Heroku dynamically sets a port
-const PORT = process.env.PORT || 5000;
+const PORT = process.env.PORT || 8080
 
-app.use(express.static("dist"));
+app.use(express.static('dist'))
 
+app.get('/health', (req, res) => {
+  // throw new Error('error...')
+  // eslint-disable-next-line no-unreachable
+  res.send('ok')
+})
+
+app.get('/version', (req, res) => {
+  res.send('1') // change this string to ensure a new version deployed
+})
 app.listen(PORT, () => {
-  console.log("server started on port 5000");
-});
+  // eslint-disable-next-line no-console
+  console.log('server started on port 8080')
+})

cypress.config.js

@@ -0,0 +1,9 @@
+const { defineConfig } = require('cypress')
+
+module.exports = defineConfig({
+  e2e: {
+    setupNodeEvents() {
+      // implement node event listeners here
+    },
+  },
+})

cypress/e2e/pokemon_app.cy.js

@@ -0,0 +1,15 @@
+// eslint disable no-undef for this file
+/* eslint-disable no-undef */
+describe('Pokedex', function() {
+  it('front page can be opened', function() {
+    cy.visit('http://localhost:8080')
+    cy.contains('ivysaur')
+    cy.contains('Pokémon and Pokémon character names are trademarks of Nintendo.')
+  })
+  it('pokemon page can be navigated to', function() {
+    cy.visit('http://localhost:8080')
+
+    cy.contains('ivysaur').click()
+    cy.contains('chlorophyll')
+  })
+})

cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "hello@cypress.io",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

cypress/support/commands.js

@@ -0,0 +1,25 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })

cypress/support/e2e.js

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/e2e.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

fly.toml

@@ -0,0 +1,56 @@
+# fly.toml app configuration file generated for full-stack-open-pokedex-cicd on 2024-01-01T17:38:36-05:00
+#
+# See https://fly.io/docs/reference/configuration/ for information about how to use this file.
+#
+
+app = "full-stack-open-pokedex-cicd"
+primary_region = "iad"
+
+[experimental]
+  auto_rollback = true
+
+[build]
+  [build.args]
+    NODE_VERSION = "16.20.2"
+
+[deploy]
+  release_command = "npm run build"
+
+[processes]
+  app = "node app.js"
+
+[http_service]
+  internal_port = 8080
+  force_https = true
+  auto_stop_machines = true
+  auto_start_machines = true
+  min_machines_running = 0
+  processes = ["app"]
+
+[[services]]
+  protocol = "tcp"
+  internal_port = 8080
+  auto_stop_machines = true
+  auto_start_machines = true
+  min_machines_running = 0
+  processes = ["app"]
+
+  [[services.tcp_checks]]
+    interval = "15s"
+    timeout = "2s"
+    grace_period = "1s"
+
+  [[services.http_checks]]
+    interval = "10s"
+    timeout = "2s"
+    grace_period = "5s"
+    method = "get"
+    path = "/health"
+    protocol = "http"
+    tls_skip_verify = false
+
+[[vm]]
+  cpu_kind = "shared"
+  cpus = 1
+  memory_mb = 1024
+  processes = ["app"]

health_check.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+res=$(curl -s https://full-stack-open-pokedex-cicd.fly.dev/health)
+
+if [ "$res" == "ok" ]; then
+  echo "Succeeded curl to /health"
+  exit 0
+  fi
+
+echo "Failed curl to /health"
+# 0: OK, 1: Bad.
+exit 1