diff --git a/.formatter.exs b/.formatter.exs index d2cda26..e945e12 100644 --- a/.formatter.exs +++ b/.formatter.exs @@ -1,4 +1,5 @@ -# Used by "mix format" [ - inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"] + import_deps: [:phoenix], + plugins: [Phoenix.LiveView.HTMLFormatter], + inputs: ["*.{heex,ex,exs}", "{config,lib,test}/**/*.{heex,ex,exs}"] ] diff --git a/.github/workflows/pr-ci.yaml b/.github/workflows/pr-ci.yaml index ca559e8..6861967 100644 --- a/.github/workflows/pr-ci.yaml +++ b/.github/workflows/pr-ci.yaml @@ -98,9 +98,8 @@ jobs: - name: Mix Audit run: mix deps.audit - # NOTE: This will be enabled when deployex becomes a phoenix app - # - name: Mix Sobelow - # run: mix sobelow --exit --threshold medium --skip -i Config.HTTPS + - name: Mix Sobelow + run: mix sobelow --exit --threshold medium --skip -i Config.HTTPS - name: Formatted run: mix format --check-formatted diff --git a/.github/workflows/releases.yaml b/.github/workflows/releases.yaml index 33d1379..e0169fc 100644 --- a/.github/workflows/releases.yaml +++ b/.github/workflows/releases.yaml @@ -25,6 +25,9 @@ jobs: - name: Install Elixir dependencies run: mix do deps.get, compile --warnings-as-errors + - name: Assets Deploy + run: mix assets.deploy + - name: Compile and Generate a Release run: mix release @@ -85,4 +88,4 @@ jobs: uses: ncipollo/release-action@v1 with: artifacts: "deployex-ubuntu-20.04.tar.gz, deployex-ubuntu-22.04.tar.gz" - bodyFile: "changelog.md" + bodyFile: "CHANGELOG.md" diff --git a/.gitignore b/.gitignore index 6eaebee..886458e 100644 --- a/.gitignore +++ b/.gitignore @@ -7,7 +7,7 @@ # The directory Mix downloads your dependencies sources to. /deps/ -# Where third-party dependencies like ExDoc output generated docs. +# Where 3rd-party dependencies like ExDoc output generated docs. /doc/ # Ignore .fetch files in case you like to edit your project deps locally. @@ -19,12 +19,21 @@ erl_crash.dump # Also ignore archive artifacts (built via "mix archive.build"). *.ez +# Temporary files, for example, from tests. +/tmp/ + # Ignore package tarball (built via "mix hex.build"). deployex-*.tar -deployex-*.tar.gz -# Temporary files, for example, from tests. -/tmp/ +# Ignore assets that are produced by build tools. +/priv/static/assets/ + +# Ignore digested assets cache. +/priv/static/cache_manifest.json + +# In case you use Node.js/npm, you want to ignore these. +npm-debug.log +/assets/node_modules/ # Dialyzer /priv/plts/*.plt diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..696607d --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,28 @@ +# Changelog + +## 0.2.0 ๐Ÿš€ (2024-05-23) + +This release marks a transformation of the application, transitioning it into a Phoenix LiveView app featuring a dashboard providing real-time status updates on the current deployment. + +## Backwards incompatible changes for 0.1.0 + * This version requires new environment variables to be defined. Please ensure the following environment variables are set. + +### Bug fixes + * None + +### Enhancements + * Transitioning it into a Phoenix LiveView app featuring a dashboard providing real-time status updates on the current deployment. + * Changed changelog.md to CHANGELOG.md + +## 0.1.0 ๐Ÿš€ (2024-05-06) + +Initial release for deployex + +# Host Binaries Available + +This release includes binaries for the following Ubuntu versions: + + * Ubuntu 20.04 + * Ubuntu 22.04 + + You can use these pre-built binaries, or you can build your own if preferred. diff --git a/README.md b/README.md index 28188c9..33de635 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,11 @@ Deployex is currently used by [Calori Web Server](https://github.com/thiagoestev The Deployex project is still very new and requires the addition of numerous features to become a comprehensive deployment solution. Below are some of the features it can incorporate: +- [X] Convert project to a Phoenix app and add a dashboard view status +- [ ] Phoenix Aapp: Add log view tab +- [ ] Phoenix Aapp: Add iex CLI tab - [ ] Execute migrations before full deployment - [ ] OTP Distribution monitoring for health checks -- [ ] Convert project to a Phoenix app and add a dashboard view status - [ ] Full deployment rollback functionality ## Getting Started @@ -24,28 +26,38 @@ The Deployex project is still very new and requires the addition of numerous fea You can kickstart the setup with the following commands: ```bash mix deps.get -iex --sname deployex -S mix -11:13:09.507 [info] module=Deployex.Monitor function=start_service/2 pid=<0.230.0> No version set, not able to start_service +iex --sname deployex -S mix phx.server +[info] No version set, not able to start_service +[info] Running DeployexWeb.Endpoint with Bandit 1.5.2 at 127.0.0.1:5001 (http) +[info] Access DeployexWeb.Endpoint at http://localhost:5001 +[watch] build finished, watching for changes... Erlang/OTP 26 [erts-14.1.1] [source] [64-bit] [smp:10:10] [ds:10:10:10] [async-threads:1] [jit] Interactive Elixir (1.16.0) - press Ctrl+C to exit (type h() ENTER for help) -11:13:14.518 [error] module=Deployex.Storage.Local function=get_current_version_map/0 pid=<0.229.0> Invalid version map at: /tmp/myphoenixapp/versions/myphoenixapp/local/current.json reason: enoent -iex(deployex@hostname)1> + +Rebuilding... + +Done in 166ms. +[error] Invalid version map at: /tmp/myphoenixapp/versions/myphoenixapp/local/current.json reason: enoent ``` -The error message is due to no monitored app is available to be deployed. If you want to proceed for a local test, follow the next steps. Also, it is important to note that the distribution will be required so this is the reason to add `-sname deployex` in the command. +Now you can visit [`localhost:5001`](http://localhost:5001) from your browser. You shold see as per the picture: + +![Running with no monitored apps](/docs/deployex_server.png) -### How Deployex handles application Version/Release +*__PS: The error message in the CLI is due to no monitored app is available to be deployed. If you want to proceed for a local test, follow the next steps. Also, it is important to note that the distribution will be required so this is the reason to add `-sname deployex` in the command.__* -The Deployex app expects a `current.json` file to be present, which contains version and hash information. This file is crucial for deployment and hot upgrades. +### How Deployex handles monitored application Version/Release + +The Deployex app expects a `current.json` file to be available, which contains version and hash information. This file is mandatory for full deployment and hot upgrades. #### Version file (current.json) Expected location in the storage folder: ```bash -# production -{s3}/versions/{monitored_app}/{env}/current.json -# local test +# production path +s3://{monitored_app}-{env}-distribution/versions/{monitored_app}/{env}/current.json +# local test path /tmp/{monitored_app}/versions/{monitored_app}/{env}/current.json ``` @@ -63,13 +75,31 @@ Once the file is captured, the deployment will start if no app is running or if Expected location in the storage folder: ```bash -# production -{s3}/dist/{monitored_app}/{monitored_app}-{version}.tar.gz -# local test +# production path +s3://{monitored_app}-{env}-distribution/dist/{monitored_app}/{monitored_app}-{version}.tar.gz +# local test path /tmp/{monitored_app}/dist/{monitored_app}/{monitored_app}-{version}.tar.gz ``` -### Running Deployex and Monitored app locally +## Environment Variables + +This Phoenix application typically requires several environment variables to be defined for proper operation. Ensure that you have the following environment variables set when running in production: + +| ENV NAME | EXAMPLE | SOURCE | DESCRIPTION | +|----------|-------------|------:|------| +| __DEPLOYEX_SECRET_KEY_BASE__ | 42otsNl...Fpq3dIJ02 | aws secrets | secret key used for encryption | +| __DEPLOYEX_ERLANG_COOKIE__ | cookie | aws secrets | erlang cookie | +| __DEPLOYEX_MONITORED_APP_NAME__ | myphoenixapp | system ENV | Monitored app name | +| __DEPLOYEX_STORAGE_ADAPTER__ | s3 | system ENV | storage adapter type | +| __DEPLOYEX_CLOUD_ENVIRONMENT__ | prod | system ENV | cloud env name | +| __DEPLOYEX_PHX_SERVER__ | true | system ENV | enable/disable server | +| __DEPLOYEX_PHX_HOST__ | example.com | system ENV | The hostname for your application | +| __DEPLOYEX_PHX_PORT__ | 5001 | system ENV | The port on which the application will run | +| __AWS_REGION__ | us-east2 | system ENV | the aws region | + +For local testing, these variables are not expected or set to default values. + +## Running Deployex and Monitored app locally For local testing, the root path used is `/tmp/{monitored_app}`. Follow these steps: @@ -82,7 +112,7 @@ mkdir -p /tmp/${monitored_app_name}/versions/${monitored_app_name}/local/ Go to the application you want to deploy/monitor and create a release. In this example, we create a brand new application using phx.new and added the library [Jellyfish](https://github.com/thiagoesteves/jellyfish) for testing hotupgrades. -#### Creating an Elixir phoenix app (default name is `myphoenixapp`) +### Creating an Elixir phoenix app (default name is `myphoenixapp`) ```bash mix local.hex @@ -91,7 +121,7 @@ mix phx.new myphoenixapp --no-ecto cd myphoenixapp ``` -#### Add env.sh.eex file in the release folder to configure the OTP distribution +### Add env.sh.eex file in the release folder to configure the OTP distribution ```bash vi rel/env.sh.eex @@ -105,12 +135,12 @@ export RELEASE_NODE=<%= @release.name %> # save the file :wq ``` -#### The next steps are needed only for Hot upgrades -Add [Jellyfish](https://github.com/thiagoesteves/jellyfish) library ONLY if the application will need hotupgrades +### The next steps are needed ONLY for Hot upgrades +Add [Jellyfish](https://github.com/thiagoesteves/jellyfish) library __ONLY__ if the application will need hotupgrades ```elixir def deps do [ - {:jellyfish, "~> 0.1.1"} + {:jellyfish, "~> 0.1.2"} ] end ``` @@ -145,7 +175,7 @@ live_reload: [ ] ``` -#### Generate a release +### Generate a release Then you can compile and generate a release ```bash mix deps.get @@ -165,7 +195,7 @@ cp _build/prod/myphoenixapp-0.1.0.tar.gz /tmp/myphoenixapp/dist/myphoenixapp echo "{\"version\":\"0.1.0\",\"hash\":\"local\"}" | jq > /tmp/myphoenixapp/versions/myphoenixapp/local/current.json ``` -#### Running Deployex and deploy the app +### Running Deployex and deploy the app Move back to the deployex project and run the command line with the required ENV vars. @@ -173,11 +203,10 @@ Move back to the deployex project and run the command line with the required ENV ```bash export SECRET_KEY_BASE=e4CXwPpjrAJp9NbRobS8dXmOHfn0EBpFdhZlPmZo1y3N/BzW9Z/k7iP7FjMk+chi export PHX_SERVER=true -iex --sname deployex -S mix -11:18:26.375 [info] module=Deployex.Monitor function=start_service/2 pid=<0.230.0> No version set, not able to start_service -Erlang/OTP 26 [erts-14.1.1] [source] [64-bit] [smp:10:10] [ds:10:10:10] [async-threads:1] [jit] +iex --sname deployex -S mix phx.server + +... -Interactive Elixir (1.16.0) - press Ctrl+C to exit (type h() ENTER for help) 11:18:31.380 [info] module=Deployex.Deployment function=run_check/1 pid=<0.229.0> Update is needed from to 0.1.0. 11:18:31.592 [warning] module=Deployex.Upgrade function=check/3 pid=<0.229.0> HOT UPGRADE version NOT DETECTED, full deployment required, result: {:error, :no_match_versions} 11:18:31.592 [info] module=Deployex.Monitor function=handle_call/3 pid=<0.230.0> Requested to stop but application is not running. @@ -193,11 +222,11 @@ iex(deployex@hostname)1> Node.set_cookie :cookie true ``` -You should then visit the applciation and check it is running [localhost:4000](http://localhost:4000/) +You should then visit the application and check it is running [localhost:5001](http://localhost:5001/) -#### Updating the application +### Updating the application -##### Full deployment +#### Full deployment In this scenario, the existing application will undergo termination, paving the way for the deployment of the new one. It's crucial to maintain the continuous operation of Deployex throughout this process. Navigate to the `myphoenixapp` project and increment the version in the `mix.exs` file. Typically, during release execution, the CI/CD pipeline either generates the package from scratch or relies on the precompiled version, particularly for hot-upgrades. If you've incorporated the [Jellyfish](https://github.com/thiagoesteves/jellyfish) library and wish to exclusively create the full deployment package, for this test you must follow the steps: @@ -235,9 +264,9 @@ echo "{\"version\":\"0.1.1\",\"hash\":\"local\"}" | jq > /tmp/myphoenixapp/versi 11:22:04.950 [info] module=Deployex.Monitor function=start_service/2 pid=<0.230.0> - Running, monitoring pid = #PID<0.249.0>, OS process id = 9289. ``` -##### Hot-upgrades +#### Hot-upgrades -For this scenario, the project must first be compiled to the current version and subsequently compiled for the version it's expected to update to. The current.json file deployed includes the git hash representing the current application version. In this local testing phase, it suffices to compile for the previous version, such as `0.1.1`, and the subsequent version, like `0.1.2`, so the necessary files will be automatically populated. +For this scenario, the project must first be compiled to the current version and subsequently compiled for the version it's expected to update to. The `current.json` file deployed includes the git hash representing the current application version. In this local testing phase, it suffices to compile for the previous version, such as `0.1.1`, and the subsequent version, like `0.1.2`, so the necessary files will be automatically populated. 1. Since the application is already compiled for `0.1.1`, change the `mix.exs` to `0.1.2`, apply any other changes if you want to test and execute the command: ```bash @@ -273,9 +302,9 @@ You can then check that deployex had executed a hot upgrade in the application: 14:18:20.927 [info] module=Deployex.Upgrade function=run/2 pid=<0.235.0> Release upgrade executed with success from 0.1.1 to 0.1.2 ``` -#### Enhancing OTP Distribution Security with mTLS +### Enhancing OTP Distribution Security with mTLS -In order to improve security, mutal TLS (`mTLS` for short) can be employed to encrypt communication during OTP distribution. To implement this, follow these steps: +In order to improve security, mutual TLS (`mTLS` for short) can be employed to encrypt communication during OTP distribution. To implement this, follow these steps: 1. Generate the necessary certificates: ```bash @@ -320,7 +349,7 @@ EOF 4. To enable `mTLS` for deployex, set the appropriate Erlang options before running the application in the terminal: ```bash -ELIXIR_ERL_OPTIONS="-proto_dist inet_tls -ssl_dist_optfile /tmp/inet_tls.conf" iex --sname deployex -S mix +ELIXIR_ERL_OPTIONS="-proto_dist inet_tls -ssl_dist_optfile /tmp/inet_tls.conf -setcookie cookie" iex --sname deployex -S mix phx.server ``` 5. Ensure that `myphoenixapp` also utilizes the same options and certificate by updating `rel/env.sh.eex`: @@ -336,9 +365,31 @@ After making these changes, remove any previous `myphoenixapp` releases that do *__ATTENTION: Ensure that the cookie is properly set__* -### How Deployex handles services +## Throubleshooting -#### Full deployment +### Accessing monitored app logs + +```bash +export monitored_app_name=myphoenixapp +# production +tail -f /var/log/${monitored_app_name}-stdout.log +# local test +tail -f /tmp/${monitored_app_name}/${monitored_app_name}-stdout.log +``` + +### Connecting to the monitored app CLI + +```bash +export monitored_app_name=calori +# production +/var/lib/deployex/service/${monitored_app_name}/current/bin/${monitored_app_name} remote +# local test +/tmp/deployex/varlib/service/${monitored_app_name}/current/bin/${monitored_app_name} remote +``` + +## How Deployex handles services + +### Full deployment Deployex operates by monitoring applications and versions using folders and files, treating the monitored app as a service. The deployment process involves several steps to ensure smooth transitions: @@ -359,19 +410,19 @@ By following this process, Deployex facilitates deployments, ensuring that appli For the test environment: ```bash -/tmp/deployex/varlib/service/{monitored_app}/old/{app_bin} -/tmp/deployex/varlib/service/{monitored_app}/new/{app_bin} -/tmp/deployex/varlib/service/{monitored_app}/current/{app_bin} +/tmp/deployex/varlib/service/{monitored_app}/old/{monitored_app} +/tmp/deployex/varlib/service/{monitored_app}/new/{monitored_app} +/tmp/deployex/varlib/service/{monitored_app}/current/{monitored_app} ``` For production environment: ```bash -/var/lib/deployex/service/{monitored_app}/old/{app_bin} -/var/lib/deployex/service/{monitored_app}/new/{app_bin} -/var/lib/deployex/service/{monitored_app}/current/{app_bin} +/var/lib/deployex/service/{monitored_app}/old/{monitored_app} +/var/lib/deployex/service/{monitored_app}/new/{monitored_app} +/var/lib/deployex/service/{monitored_app}/current/{monitored_app} ``` -#### Hot-upgrades +### Hot-upgrades For this scenario, there will be no moving files/folders since the target is to keep the current service folder updated. The sequence is: diff --git a/assets/css/app.css b/assets/css/app.css new file mode 100644 index 0000000..378c8f9 --- /dev/null +++ b/assets/css/app.css @@ -0,0 +1,5 @@ +@import "tailwindcss/base"; +@import "tailwindcss/components"; +@import "tailwindcss/utilities"; + +/* This file is for your main application CSS */ diff --git a/assets/js/app.js b/assets/js/app.js new file mode 100644 index 0000000..d5e278a --- /dev/null +++ b/assets/js/app.js @@ -0,0 +1,44 @@ +// If you want to use Phoenix channels, run `mix help phx.gen.channel` +// to get started and then uncomment the line below. +// import "./user_socket.js" + +// You can include dependencies in two ways. +// +// The simplest option is to put them in assets/vendor and +// import them using relative paths: +// +// import "../vendor/some-package.js" +// +// Alternatively, you can `npm install some-package --prefix assets` and import +// them using a path starting with the package name: +// +// import "some-package" +// + +// Include phoenix_html to handle method=PUT/DELETE in forms and buttons. +import "phoenix_html" +// Establish Phoenix Socket and LiveView configuration. +import {Socket} from "phoenix" +import {LiveSocket} from "phoenix_live_view" +import topbar from "../vendor/topbar" + +let csrfToken = document.querySelector("meta[name='csrf-token']").getAttribute("content") +let liveSocket = new LiveSocket("/live", Socket, { + longPollFallbackMs: 2500, + params: {_csrf_token: csrfToken} +}) + +// Show progress bar on live navigation and form submits +topbar.config({barColors: {0: "#29d"}, shadowColor: "rgba(0, 0, 0, .3)"}) +window.addEventListener("phx:page-loading-start", _info => topbar.show(300)) +window.addEventListener("phx:page-loading-stop", _info => topbar.hide()) + +// connect if there are any LiveViews on the page +liveSocket.connect() + +// expose liveSocket on window for web console debug logs and latency simulation: +// >> liveSocket.enableDebug() +// >> liveSocket.enableLatencySim(1000) // enabled for duration of browser session +// >> liveSocket.disableLatencySim() +window.liveSocket = liveSocket + diff --git a/assets/tailwind.config.js b/assets/tailwind.config.js new file mode 100644 index 0000000..a68582f --- /dev/null +++ b/assets/tailwind.config.js @@ -0,0 +1,75 @@ +// See the Tailwind configuration guide for advanced usage +// https://tailwindcss.com/docs/configuration + +const plugin = require("tailwindcss/plugin") +const fs = require("fs") +const path = require("path") + +module.exports = { + content: [ + "./js/**/*.js", + "../lib/deployex_web.ex", + "../lib/deployex_web/**/*.*ex" + ], + theme: { + extend: { + colors: { + brand: "#FD4F00", + } + }, + }, + plugins: [ + require("@tailwindcss/forms"), + // Allows prefixing tailwind classes with LiveView classes to add rules + // only when LiveView classes are applied, for example: + // + //
+ // + plugin(({addVariant}) => addVariant("phx-no-feedback", [".phx-no-feedback&", ".phx-no-feedback &"])), + plugin(({addVariant}) => addVariant("phx-click-loading", [".phx-click-loading&", ".phx-click-loading &"])), + plugin(({addVariant}) => addVariant("phx-submit-loading", [".phx-submit-loading&", ".phx-submit-loading &"])), + plugin(({addVariant}) => addVariant("phx-change-loading", [".phx-change-loading&", ".phx-change-loading &"])), + + // Embeds Heroicons (https://heroicons.com) into your app.css bundle + // See your `CoreComponents.icon/1` for more information. + // + plugin(function({matchComponents, theme}) { + let iconsDir = path.join(__dirname, "../deps/heroicons/optimized") + let values = {} + let icons = [ + ["", "/24/outline"], + ["-solid", "/24/solid"], + ["-mini", "/20/solid"], + ["-micro", "/16/solid"] + ] + icons.forEach(([suffix, dir]) => { + fs.readdirSync(path.join(iconsDir, dir)).forEach(file => { + let name = path.basename(file, ".svg") + suffix + values[name] = {name, fullPath: path.join(iconsDir, dir, file)} + }) + }) + matchComponents({ + "hero": ({name, fullPath}) => { + let content = fs.readFileSync(fullPath).toString().replace(/\r?\n|\r/g, "") + let size = theme("spacing.6") + if (name.endsWith("-mini")) { + size = theme("spacing.5") + } else if (name.endsWith("-micro")) { + size = theme("spacing.4") + } + return { + [`--hero-${name}`]: `url('data:image/svg+xml;utf8,${content}')`, + "-webkit-mask": `var(--hero-${name})`, + "mask": `var(--hero-${name})`, + "mask-repeat": "no-repeat", + "background-color": "currentColor", + "vertical-align": "middle", + "display": "inline-block", + "width": size, + "height": size + } + } + }, {values}) + }) + ] +} diff --git a/assets/vendor/topbar.js b/assets/vendor/topbar.js new file mode 100644 index 0000000..4195727 --- /dev/null +++ b/assets/vendor/topbar.js @@ -0,0 +1,165 @@ +/** + * @license MIT + * topbar 2.0.0, 2023-02-04 + * https://buunguyen.github.io/topbar + * Copyright (c) 2021 Buu Nguyen + */ +(function (window, document) { + "use strict"; + + // https://gist.github.com/paulirish/1579671 + (function () { + var lastTime = 0; + var vendors = ["ms", "moz", "webkit", "o"]; + for (var x = 0; x < vendors.length && !window.requestAnimationFrame; ++x) { + window.requestAnimationFrame = + window[vendors[x] + "RequestAnimationFrame"]; + window.cancelAnimationFrame = + window[vendors[x] + "CancelAnimationFrame"] || + window[vendors[x] + "CancelRequestAnimationFrame"]; + } + if (!window.requestAnimationFrame) + window.requestAnimationFrame = function (callback, element) { + var currTime = new Date().getTime(); + var timeToCall = Math.max(0, 16 - (currTime - lastTime)); + var id = window.setTimeout(function () { + callback(currTime + timeToCall); + }, timeToCall); + lastTime = currTime + timeToCall; + return id; + }; + if (!window.cancelAnimationFrame) + window.cancelAnimationFrame = function (id) { + clearTimeout(id); + }; + })(); + + var canvas, + currentProgress, + showing, + progressTimerId = null, + fadeTimerId = null, + delayTimerId = null, + addEvent = function (elem, type, handler) { + if (elem.addEventListener) elem.addEventListener(type, handler, false); + else if (elem.attachEvent) elem.attachEvent("on" + type, handler); + else elem["on" + type] = handler; + }, + options = { + autoRun: true, + barThickness: 3, + barColors: { + 0: "rgba(26, 188, 156, .9)", + ".25": "rgba(52, 152, 219, .9)", + ".50": "rgba(241, 196, 15, .9)", + ".75": "rgba(230, 126, 34, .9)", + "1.0": "rgba(211, 84, 0, .9)", + }, + shadowBlur: 10, + shadowColor: "rgba(0, 0, 0, .6)", + className: null, + }, + repaint = function () { + canvas.width = window.innerWidth; + canvas.height = options.barThickness * 5; // need space for shadow + + var ctx = canvas.getContext("2d"); + ctx.shadowBlur = options.shadowBlur; + ctx.shadowColor = options.shadowColor; + + var lineGradient = ctx.createLinearGradient(0, 0, canvas.width, 0); + for (var stop in options.barColors) + lineGradient.addColorStop(stop, options.barColors[stop]); + ctx.lineWidth = options.barThickness; + ctx.beginPath(); + ctx.moveTo(0, options.barThickness / 2); + ctx.lineTo( + Math.ceil(currentProgress * canvas.width), + options.barThickness / 2 + ); + ctx.strokeStyle = lineGradient; + ctx.stroke(); + }, + createCanvas = function () { + canvas = document.createElement("canvas"); + var style = canvas.style; + style.position = "fixed"; + style.top = style.left = style.right = style.margin = style.padding = 0; + style.zIndex = 100001; + style.display = "none"; + if (options.className) canvas.classList.add(options.className); + document.body.appendChild(canvas); + addEvent(window, "resize", repaint); + }, + topbar = { + config: function (opts) { + for (var key in opts) + if (options.hasOwnProperty(key)) options[key] = opts[key]; + }, + show: function (delay) { + if (showing) return; + if (delay) { + if (delayTimerId) return; + delayTimerId = setTimeout(() => topbar.show(), delay); + } else { + showing = true; + if (fadeTimerId !== null) window.cancelAnimationFrame(fadeTimerId); + if (!canvas) createCanvas(); + canvas.style.opacity = 1; + canvas.style.display = "block"; + topbar.progress(0); + if (options.autoRun) { + (function loop() { + progressTimerId = window.requestAnimationFrame(loop); + topbar.progress( + "+" + 0.05 * Math.pow(1 - Math.sqrt(currentProgress), 2) + ); + })(); + } + } + }, + progress: function (to) { + if (typeof to === "undefined") return currentProgress; + if (typeof to === "string") { + to = + (to.indexOf("+") >= 0 || to.indexOf("-") >= 0 + ? currentProgress + : 0) + parseFloat(to); + } + currentProgress = to > 1 ? 1 : to; + repaint(); + return currentProgress; + }, + hide: function () { + clearTimeout(delayTimerId); + delayTimerId = null; + if (!showing) return; + showing = false; + if (progressTimerId != null) { + window.cancelAnimationFrame(progressTimerId); + progressTimerId = null; + } + (function loop() { + if (topbar.progress("+.1") >= 1) { + canvas.style.opacity -= 0.05; + if (canvas.style.opacity <= 0.05) { + canvas.style.display = "none"; + fadeTimerId = null; + return; + } + } + fadeTimerId = window.requestAnimationFrame(loop); + })(); + }, + }; + + if (typeof module === "object" && typeof module.exports === "object") { + module.exports = topbar; + } else if (typeof define === "function" && define.amd) { + define(function () { + return topbar; + }); + } else { + this.topbar = topbar; + } +}.call(this, window, document)); diff --git a/changelog.md b/changelog.md deleted file mode 100644 index 67a01b1..0000000 --- a/changelog.md +++ /dev/null @@ -1,7 +0,0 @@ -# Changelog for Elixir v0.1.0 - -This is the first release for deployex - -## Supported Hosts - * Ubuntu 20.04 - * Ubuntu 22.04 diff --git a/config/config.exs b/config/config.exs index 9932399..6dc16f8 100644 --- a/config/config.exs +++ b/config/config.exs @@ -4,21 +4,74 @@ # This configuration file is loaded before any dependency and # is restricted to this project. +# General application configuration +# This file is responsible for configuring your application +# and its dependencies with the aid of the Config module. +# +# This configuration file is loaded before any dependency and +# is restricted to this project. + # General application configuration import Config monitored_app_name = System.get_env("DEPLOYEX_MONITORED_APP_NAME", "myphoenixapp") config :deployex, + generators: [timestamp_type: :utc_datetime], env: "local", monitored_app_name: monitored_app_name, monitored_app_log_path: "/tmp/#{monitored_app_name}", base_path: "/tmp/deployex/varlib" +# Configures the endpoint +config :deployex, DeployexWeb.Endpoint, + url: [host: "localhost"], + adapter: Bandit.PhoenixAdapter, + render_errors: [ + formats: [html: DeployexWeb.ErrorHTML, json: DeployexWeb.ErrorJSON], + layout: false + ], + pubsub_server: Deployex.PubSub, + live_view: [signing_salt: "t2YabqhV"] + +# Configures the mailer +# +# By default it uses the "Local" adapter which stores the emails +# locally. You can see the emails in your browser, at "/dev/mailbox". +# +# For production it's recommended to configure a different adapter +# at the `config/runtime.exs`. +config :deployex, Deployex.Mailer, adapter: Swoosh.Adapters.Local + +# Configure esbuild (the version is required) +config :esbuild, + version: "0.17.11", + deployex: [ + args: + ~w(js/app.js --bundle --target=es2017 --outdir=../priv/static/assets --external:/fonts/* --external:/images/*), + cd: Path.expand("../assets", __DIR__), + env: %{"NODE_PATH" => Path.expand("../deps", __DIR__)} + ] + +# Configure tailwind (the version is required) +config :tailwind, + version: "3.4.0", + deployex: [ + args: ~w( + --config=tailwind.config.js + --input=css/app.css + --output=../priv/static/assets/app.css + ), + cd: Path.expand("../assets", __DIR__) + ] + +# Use Jason for JSON parsing in Phoenix +config :phoenix, :json_library, Jason + # Configures Elixir's Logger config :logger, :console, format: "$time [$level] $metadata $message\n", - metadata: [:module, :function, :pid] + metadata: [:request_i, :module, :function, :pid] # AWS Configuration config :ex_aws, diff --git a/config/dev.exs b/config/dev.exs index becde76..02e0dff 100644 --- a/config/dev.exs +++ b/config/dev.exs @@ -1 +1,75 @@ import Config + +# For development, we disable any cache and enable +# debugging and code reloading. +# +# The watchers configuration can be used to run external +# watchers to your application. For example, we can use it +# to bundle .js and .css sources. +config :deployex, DeployexWeb.Endpoint, + # Binding to loopback ipv4 address prevents access from other machines. + # Change to `ip: {0, 0, 0, 0}` to allow access from other machines. + http: [ip: {127, 0, 0, 1}, port: 5001], + check_origin: false, + code_reloader: true, + debug_errors: true, + secret_key_base: "5uEOcuaw3Kj/phO6Nw6G161eQk3KnF4F4T5cpdYvXgyTDnzR61hh/bYWXttnLzBJ", + watchers: [ + esbuild: {Esbuild, :install_and_run, [:deployex, ~w(--sourcemap=inline --watch)]}, + tailwind: {Tailwind, :install_and_run, [:deployex, ~w(--watch)]} + ] + +# ## SSL Support +# +# In order to use HTTPS in development, a self-signed +# certificate can be generated by running the following +# Mix task: +# +# mix phx.gen.cert +# +# Run `mix help phx.gen.cert` for more information. +# +# The `http:` config above can be replaced with: +# +# https: [ +# port: 4001, +# cipher_suite: :strong, +# keyfile: "priv/cert/selfsigned_key.pem", +# certfile: "priv/cert/selfsigned.pem" +# ], +# +# If desired, both `http:` and `https:` keys can be +# configured to run both http and https servers on +# different ports. + +# Watch static and templates for browser reloading. +config :deployex, DeployexWeb.Endpoint, + live_reload: [ + patterns: [ + ~r"priv/static/(?!uploads/).*(js|css|png|jpeg|jpg|gif|svg)$", + ~r"priv/gettext/.*(po)$", + ~r"lib/deployex_web/(controllers|live|components)/.*(ex|heex)$" + ] + ] + +# Enable dev routes for dashboard and mailbox +config :deployex, dev_routes: true + +# Do not include metadata nor timestamps in development logs +config :logger, :console, format: "[$level] $message\n" + +# Set a higher stacktrace during development. Avoid configuring such +# in production as building large stacktraces may be expensive. +config :phoenix, :stacktrace_depth, 20 + +# Initialize plugs at runtime for faster development compilation +config :phoenix, :plug_init_mode, :runtime + +config :phoenix_live_view, + # Include HEEx debug annotations as HTML comments in rendered markup + debug_heex_annotations: true, + # Enable helpful, but potentially expensive runtime checks + enable_expensive_runtime_checks: true + +# Disable swoosh api client as it is only required for production adapters. +config :swoosh, :api_client, false diff --git a/config/prod.exs b/config/prod.exs index 2d32725..201e0a2 100644 --- a/config/prod.exs +++ b/config/prod.exs @@ -1,5 +1,21 @@ import Config +# Note we also include the path to a cache manifest +# containing the digested version of static files. This +# manifest is generated by the `mix assets.deploy` task, +# which you should run after static files are built and +# before starting your production server. +config :deployex, DeployexWeb.Endpoint, cache_static_manifest: "priv/static/cache_manifest.json" + +# Configures Swoosh API Client +config :swoosh, api_client: Swoosh.ApiClient.Finch, finch_name: Deployex.Finch + +# Disable Swoosh Local Memory Storage +config :swoosh, local: false + +# Runtime production configuration, including reading +# of environment variables, is done on config/runtime.exs. + config :deployex, base_path: "/var/lib/deployex" diff --git a/config/runtime.exs b/config/runtime.exs index 6ea0cdd..b9e6eb6 100644 --- a/config/runtime.exs +++ b/config/runtime.exs @@ -7,6 +7,19 @@ import Config # any compile-time configuration in here, as it won't be applied. # The block below contains prod specific runtime configuration. +# ## Using releases +# +# If you use `mix release`, you need to explicitly enable the server +# by passing the PHX_SERVER=true when you start it: +# +# PHX_SERVER=true bin/deployex start +# +# Alternatively, you can use `mix phx.gen.release` to generate a `bin/server` +# script that automatically sets the env var above. +if System.get_env("DEPLOYEX_PHX_SERVER") do + config :deployex, DeployexWeb.Endpoint, server: true +end + if config_env() == :prod do # Set the cloud environment flag config :deployex, @@ -16,4 +29,70 @@ if config_env() == :prod do config :ex_aws, region: System.fetch_env!("AWS_REGION") + + host = System.get_env("DEPLOYEX_PHX_HOST") || "example.com" + port = String.to_integer(System.get_env("DEPLOYEX_PHX_PORT") || "5001") + + config :deployex, :dns_cluster_query, System.get_env("DNS_CLUSTER_QUERY") + + config :deployex, DeployexWeb.Endpoint, + url: [host: host, port: 443, scheme: "https"], + http: [ + # Enable IPv6 and bind on all interfaces. + # Set it to {0, 0, 0, 0, 0, 0, 0, 1} for local network only access. + # See the documentation on https://hexdocs.pm/bandit/Bandit.html#t:options/0 + # for details about using IPv6 vs IPv4 and loopback vs public addresses. + ip: {0, 0, 0, 0, 0, 0, 0, 0}, + port: port + ] + + # ## SSL Support + # + # To get SSL working, you will need to add the `https` key + # to your endpoint configuration: + # + # config :deployex, DeployexWeb.Endpoint, + # https: [ + # ..., + # port: 443, + # cipher_suite: :strong, + # keyfile: System.get_env("SOME_APP_SSL_KEY_PATH"), + # certfile: System.get_env("SOME_APP_SSL_CERT_PATH") + # ] + # + # The `cipher_suite` is set to `:strong` to support only the + # latest and more secure SSL ciphers. This means old browsers + # and clients may not be supported. You can set it to + # `:compatible` for wider support. + # + # `:keyfile` and `:certfile` expect an absolute path to the key + # and cert in disk or a relative path inside priv, for example + # "priv/ssl/server.key". For all supported SSL configuration + # options, see https://hexdocs.pm/plug/Plug.SSL.html#configure/1 + # + # We also recommend setting `force_ssl` in your config/prod.exs, + # ensuring no data is ever sent via http, always redirecting to https: + # + # config :deployex, DeployexWeb.Endpoint, + # force_ssl: [hsts: true] + # + # Check `Plug.SSL` for all available options in `force_ssl`. + + # ## Configuring the mailer + # + # In production you need to configure the mailer to use a different adapter. + # Also, you may need to configure the Swoosh API client of your choice if you + # are not using SMTP. Here is an example of the configuration: + # + # config :deployex, Deployex.Mailer, + # adapter: Swoosh.Adapters.Mailgun, + # api_key: System.get_env("MAILGUN_API_KEY"), + # domain: System.get_env("MAILGUN_DOMAIN") + # + # For this example you need include a HTTP client required by Swoosh API client. + # Swoosh supports Hackney and Finch out of the box: + # + # config :swoosh, :api_client, Swoosh.ApiClient.Hackney + # + # See https://hexdocs.pm/swoosh/Swoosh.html#module-installation for details. end diff --git a/config/test.exs b/config/test.exs index 477c907..1105eac 100644 --- a/config/test.exs +++ b/config/test.exs @@ -1,3 +1,24 @@ import Config -config :logger, level: :info +# We don't run a server during test. If one is required, +# you can enable the server option below. +config :deployex, DeployexWeb.Endpoint, + http: [ip: {127, 0, 0, 1}, port: 4002], + secret_key_base: "hQ1CDXnnsqNi2+sEYF2SSOkj+SrzzqtbwtfjjHYgNDdH97obAtrDPjtN3HyAy6ns", + server: false + +# In test we don't send emails. +config :deployex, Deployex.Mailer, adapter: Swoosh.Adapters.Test + +# Disable swoosh api client as it is only required for production adapters. +config :swoosh, :api_client, false + +# Print only warnings and errors during test +config :logger, level: :warning + +# Initialize plugs at runtime for faster test compilation +config :phoenix, :plug_init_mode, :runtime + +config :phoenix_live_view, + # Enable helpful, but potentially expensive runtime checks + enable_expensive_runtime_checks: true diff --git a/docs/deployex.excalidraw b/docs/deployex.excalidraw index a0d814a..8d09f0b 100644 --- a/docs/deployex.excalidraw +++ b/docs/deployex.excalidraw @@ -763,13 +763,13 @@ "updated": 1715193581721, "link": null, "locked": false, - "text": "Port 4000", + "text": "Port 5001", "fontSize": 28, "fontFamily": 1, "textAlign": "center", "verticalAlign": "middle", "containerId": "8-mQY1vaiPICWZtx8HiYJ", - "originalText": "Port 4000", + "originalText": "Port 5001", "lineHeight": 1.25 }, { @@ -1539,7 +1539,7 @@ "endBinding": { "elementId": "b19n33CaAHAGhV_kIPZFq", "focus": 0.5442192759378823, - "gap": 1.1097143440008495 + "gap": 1.1097143450018495 }, "startArrowhead": null, "endArrowhead": "arrow" diff --git a/docs/deployex_server.png b/docs/deployex_server.png new file mode 100644 index 0000000..5359637 Binary files /dev/null and b/docs/deployex_server.png differ diff --git a/lib/config_provider/aws_secrets_manager.ex b/lib/config_provider/aws_secrets_manager.ex new file mode 100644 index 0000000..c3d2b2a --- /dev/null +++ b/lib/config_provider/aws_secrets_manager.ex @@ -0,0 +1,99 @@ +defmodule Deployex.AwsSecretsManagerProvider do + @moduledoc """ + https://hexdocs.pm/elixir/1.14.0-rc.1/Config.Provider.html + + Fetch secrets from AWS Secrets Manager, then load those secrets into configs. + + Similar examples: + - https://github.com/Adzz/gcp_secret_provider/blob/master/lib/gcp_secret_provider.ex + - https://github.com/sevenmind/vault_config_provider + """ + @behaviour Config.Provider + + require Logger + + alias ExAws.Operation.JSON + + @impl Config.Provider + def init(_path), do: [] + + @doc """ + load/2. + + Args: + - config is the current config + - opts is just the return value of init/1. + + Calls out to AWS Secrets Manager, parses the JSON response, sets configs to parsed response. + """ + @impl Config.Provider + def load(config, opts) do + Logger.info("Running AWS config provider") + env = Keyword.get(config, :deployex) |> Keyword.get(:env) + + if env == "local" do + Logger.info(" - No secrets retrieved, local environment") + config + else + {:ok, _} = Application.ensure_all_started(:hackney) + {:ok, _} = Application.ensure_all_started(:ex_aws) + + Logger.info(" - Retrieve secrets") + + region = System.fetch_env!("AWS_REGION") + request_opts = Keyword.merge(opts, region: region) + + secrets = fetch_aws_secret_id("deployex-#{env}-secrets", request_opts) + + secret_key_base = keyword(:secret_key_base, secrets["DEPLOYEX_SECRET_KEY_BASE"]) + erlang_cookie = secrets["DEPLOYEX_ERLANG_COOKIE"] |> String.to_atom() + + # Config Erlang Cookie if the node exist + node = :erlang.node() + + if node != :nonode@nohost do + :erlang.set_cookie(node, erlang_cookie) + end + + Config.Reader.merge( + config, + deployex: [ + {DeployexWeb.Endpoint, secret_key_base} + ] + ) + end + end + + defp keyword(key_name, value) do + Keyword.new([{key_name, value}]) + end + + defp fetch_aws_secret_id(secret_id, opts) do + secret_id + |> build_request() + |> ExAws.request(opts) + |> parse_secrets() + end + + defp build_request(secret_name) do + JSON.new( + :secretsmanager, + %{ + data: %{"SecretId" => secret_name}, + headers: [ + {"x-amz-target", "secretsmanager.GetSecretValue"}, + {"content-type", "application/x-amz-json-1.1"} + ] + } + ) + end + + defp parse_secrets({:ok, %{"SecretString" => json_secret}}) do + Jason.decode!(json_secret) + end + + defp parse_secrets({:error, {exception, reason}}) do + Logger.error("#{inspect(exception)}: #{inspect(reason)}") + %{} + end +end diff --git a/lib/deployex.ex b/lib/deployex.ex index 06d0e65..d1aac6c 100644 --- a/lib/deployex.ex +++ b/lib/deployex.ex @@ -1,3 +1,9 @@ defmodule Deployex do - @moduledoc false + @moduledoc """ + Deployex keeps the contexts that define your domain + and business logic. + + Contexts are also responsible for managing your data, regardless + if it comes from the database, an external API or others. + """ end diff --git a/lib/deployex/app_status.ex b/lib/deployex/app_status.ex new file mode 100644 index 0000000..9c300f0 --- /dev/null +++ b/lib/deployex/app_status.ex @@ -0,0 +1,200 @@ +defmodule Deployex.AppStatus do + @moduledoc """ + Module that host the current state and also provide functions to handle it + """ + + use GenServer + alias Deployex.Configuration + alias Deployex.Storage + + require Logger + + defstruct [ + :name, + :link, + :version, + :otp, + :tls, + :last_deployment, + :prev_version, + :supervisor, + :status + ] + + @update_apps_interval_ms 1_000 + @update_otp_distribution_interval_ms 5_000 + @apps_data_updated_topic "apps_data_updated" + + ### ========================================================================== + ### Callback functions + ### ========================================================================== + + def start_link(attrs) do + GenServer.start_link(__MODULE__, attrs, name: __MODULE__) + end + + @impl true + def init(_attrs) do + Process.flag(:trap_exit, true) + + :timer.send_interval(@update_apps_interval_ms, :update_apps) + :timer.send_interval(@update_otp_distribution_interval_ms, :update_otp) + + {:ok, []} + end + + @impl true + def handle_info(:update_apps, state) do + # update apps + new_state = [ + update_deployex_app(), + update_monitored_app() + ] + + if new_state != state do + Phoenix.PubSub.broadcast( + Deployex.PubSub, + "apps_data_updated", + {:update_apps_data, new_state} + ) + end + + {:noreply, new_state} + end + + @impl true + def handle_info(:update_otp, state) do + if current_version() != nil and Node.list() == [], do: Deployex.Upgrade.connect() + {:noreply, state} + end + + ### ========================================================================== + ### Public functions + ### ========================================================================== + + @spec current_version() :: String.t() | nil + def current_version do + version_map()["version"] + end + + @spec current_deployment() :: String.t() | nil + def current_deployment do + version_map()["deployment"] + end + + @spec listener_topic() :: String.t() + def listener_topic do + @apps_data_updated_topic + end + + @spec set_current_version_map(Deployex.Storage.version_map(), atom()) :: :ok + def set_current_version_map(version, deployment) when is_map(version) do + # Update previous version + case version_map() do + nil -> + Logger.warning("No previous version set") + + version -> + File.write!(previous_version_path(), version |> Jason.encode!()) + end + + version = + version + |> Map.put(:deployment, deployment) + |> Jason.encode!() + + File.write!(current_version_path(), version) + end + + @spec clear_new() :: :ok + def clear_new do + File.rm_rf(Configuration.new_path()) + File.mkdir_p(Configuration.new_path()) + :ok + end + + @spec update() :: :ok + def update do + File.rm_rf(Configuration.old_path()) + File.rename(Configuration.current_path(), Configuration.old_path()) + File.rename(Configuration.new_path(), Configuration.current_path()) + :ok + end + + ### ========================================================================== + ### Private functions + ### ========================================================================== + defp current_version_path, do: "#{Configuration.base_path()}/current.json" + defp previous_version_path, do: "#{Configuration.base_path()}/previous.json" + + defp version_map(path \\ current_version_path()) do + case File.read(path) do + {:ok, data} -> + file2json(data) + + _ -> + nil + end + end + + defp file2json(data) do + case Jason.decode(data) do + {:ok, map} -> map + _ -> nil + end + end + + defp prev_version do + version_map(previous_version_path())["version"] + end + + defp update_deployex_app do + %Deployex.AppStatus{ + name: "deployex", + link: true, + version: Application.spec(:deployex, :vsn) |> to_string, + last_deployment: nil, + otp: check_otp(), + tls: check_tls(), + prev_version: nil, + supervisor: true, + status: :running + } + end + + defp update_monitored_app do + %Deployex.AppStatus{ + name: Application.get_env(:deployex, :monitored_app_name), + link: false, + version: current_version(), + otp: check_otp(), + tls: check_tls(), + last_deployment: current_deployment(), + prev_version: prev_version(), + supervisor: false, + status: check_deployment() + } + end + + defp check_otp do + if Node.list() != [], do: :connected, else: :not_connected + end + + defp check_tls do + if :init.get_arguments()[:ssl_dist_optfile] do + :supported + else + :not_supported + end + end + + defp check_deployment do + storage = Storage.get_current_version_map() + + if storage["version"] == current_version() do + :running + else + :deploying + end + end +end diff --git a/lib/deployex/application.ex b/lib/deployex/application.ex index 334764f..7278b65 100644 --- a/lib/deployex/application.ex +++ b/lib/deployex/application.ex @@ -1,21 +1,40 @@ defmodule Deployex.Application do + # See https://hexdocs.pm/elixir/Application.html + # for more information on OTP Applications @moduledoc false use Application - ### ========================================================================== - ### Callback functions - ### ========================================================================== - @impl true def start(_type, _args) do Deployex.Configuration.init() children = [ Deployex.Deployment, - Deployex.Monitor + Deployex.Monitor, + DeployexWeb.Telemetry, + {DNSCluster, query: Application.get_env(:deployex, :dns_cluster_query) || :ignore}, + {Phoenix.PubSub, name: Deployex.PubSub}, + # Start the Finch HTTP client for sending emails + {Finch, name: Deployex.Finch}, + # Start a worker by calling: Deployex.Worker.start_link(arg) + # {Deployex.Worker, arg}, + # Start to serve requests, typically the last entry + DeployexWeb.Endpoint, + Deployex.AppStatus ] - Supervisor.start_link(children, strategy: :one_for_one, name: Deployex.Supervisor) + # See https://hexdocs.pm/elixir/Supervisor.html + # for other strategies and supported options + opts = [strategy: :one_for_one, name: Deployex.Supervisor] + Supervisor.start_link(children, opts) + end + + # Tell Phoenix to update the endpoint configuration + # whenever the application is updated. + @impl true + def config_change(changed, _new, removed) do + DeployexWeb.Endpoint.config_change(changed, removed) + :ok end end diff --git a/lib/deployex/deployment.ex b/lib/deployex/deployment.ex index 134ead9..87e6775 100644 --- a/lib/deployex/deployment.ex +++ b/lib/deployex/deployment.ex @@ -3,12 +3,12 @@ defmodule Deployex.Deployment do GenServer to trigger the deployment when it is required. """ - @schedule_interval_ms 5_000 + @deployment_schedule_interval_ms 5_000 use GenServer require Logger - alias Deployex.{State, Storage, Upgrade} + alias Deployex.{AppStatus, Storage, Upgrade} @wait_time_from_stop_ms 500 @@ -22,14 +22,16 @@ defmodule Deployex.Deployment do @impl true def init(_arg) do - schedule_check() + schedule_new_deployment() {:ok, %{}} end @impl true def handle_info(:schedule, state) do - state = run_check(state) - schedule_check() + schedule_new_deployment() + + state = check_deployment(state) + {:noreply, state} end @@ -37,11 +39,12 @@ defmodule Deployex.Deployment do ### Private functions ### ========================================================================== - defp schedule_check, do: Process.send_after(self(), :schedule, @schedule_interval_ms) + defp schedule_new_deployment, + do: Process.send_after(self(), :schedule, @deployment_schedule_interval_ms) - defp run_check(state) do + defp check_deployment(state) do storage = Storage.get_current_version_map() - current_app_version = State.current_version() || "" + current_app_version = AppStatus.current_version() || "" if storage != nil and storage["version"] != current_app_version do Logger.info("Update is needed from #{current_app_version} to #{storage["version"]}.") @@ -66,9 +69,9 @@ defmodule Deployex.Deployment do # avoid race conditions for resources since they use the same name, ports, etc. :timer.sleep(@wait_time_from_stop_ms) - State.update() + AppStatus.update() - State.set_current_version_map(storage) + AppStatus.set_current_version_map(storage, :full_deployment) :ok = Deployex.Monitor.start_service() end) @@ -76,14 +79,14 @@ defmodule Deployex.Deployment do defp hot_upgrade(storage) do :global.trans({{__MODULE__, :deploy_lock}, self()}, fn -> - from_version = State.current_version() + from_version = AppStatus.current_version() if :ok == Upgrade.run(from_version, storage["version"]) do - State.set_current_version_map(storage) + AppStatus.set_current_version_map(storage, :hot_upgrade) end end) - if State.current_version() != storage["version"] do + if AppStatus.current_version() != storage["version"] do Logger.error("Hot Upgrade failed, running for full deployment") full_deployment(storage) end diff --git a/lib/deployex/mailer.ex b/lib/deployex/mailer.ex new file mode 100644 index 0000000..e23c59a --- /dev/null +++ b/lib/deployex/mailer.ex @@ -0,0 +1,3 @@ +defmodule Deployex.Mailer do + use Swoosh.Mailer, otp_app: :deployex +end diff --git a/lib/deployex/monitor.ex b/lib/deployex/monitor.ex index ef3709b..00c1823 100644 --- a/lib/deployex/monitor.ex +++ b/lib/deployex/monitor.ex @@ -5,7 +5,7 @@ defmodule Deployex.Monitor do use GenServer require Logger - alias Deployex.{Configuration, State} + alias Deployex.{AppStatus, Configuration} # Since we are running from another release, the deployer RELEASE_* vars need to be unset" @unset_release_vars " unset $(env | grep RELEASE | awk -F'=' '{print $1}') ; " @@ -24,13 +24,13 @@ defmodule Deployex.Monitor do def init(_arg) do Process.flag(:trap_exit, true) - state = start_service(State.current_version(), %{current_pid: nil}) + state = start_service(AppStatus.current_version(), %{current_pid: nil}) {:ok, state} end @impl true def handle_call(:start_service, _from, state) do - state = start_service(State.current_version(), state) + state = start_service(AppStatus.current_version(), state) {:reply, :ok, state} end @@ -69,7 +69,7 @@ defmodule Deployex.Monitor do state = if current_pid == pid do Logger.error("Unexpected exit message received from pid: #{inspect(pid)} being restarted") - start_service(State.current_version(), state) + start_service(AppStatus.current_version(), state) else Logger.warning( "Application with pid: #{inspect(pid)} - state: #{inspect(state)} being stopped by reason: #{inspect(reason)}" diff --git a/lib/deployex/state.ex b/lib/deployex/state.ex deleted file mode 100644 index d89e46e..0000000 --- a/lib/deployex/state.ex +++ /dev/null @@ -1,54 +0,0 @@ -defmodule Deployex.State do - @moduledoc """ - Module that host the current state and also provide functions to handle it - """ - - alias Deployex.Configuration - - ### ========================================================================== - ### Public functions - ### ========================================================================== - - @spec current_version() :: map() | nil - def current_version do - case File.read(version_file()) do - {:ok, data} -> - version_map(data)["version"] - - _ -> - nil - end - end - - @spec set_current_version_map(Deployex.Storage.version_map()) :: :ok - def set_current_version_map(version) when is_map(version) do - File.write!(version_file(), version |> Jason.encode!()) - end - - @spec clear_new() :: :ok - def clear_new do - File.rm_rf(Configuration.new_path()) - File.mkdir_p(Configuration.new_path()) - :ok - end - - @spec update() :: :ok - def update do - File.rm_rf(Configuration.old_path()) - File.rename(Configuration.current_path(), Configuration.old_path()) - File.rename(Configuration.new_path(), Configuration.current_path()) - :ok - end - - ### ========================================================================== - ### Private functions - ### ========================================================================== - defp version_file, do: "#{Configuration.base_path()}/current.json" - - defp version_map(data) do - case Jason.decode(data) do - {:ok, map} -> map - _ -> nil - end - end -end diff --git a/lib/deployex/storage/local.ex b/lib/deployex/storage/local.ex index 881af0d..da8c412 100644 --- a/lib/deployex/storage/local.ex +++ b/lib/deployex/storage/local.ex @@ -5,7 +5,7 @@ defmodule Deployex.Storage.Local do @behaviour Deployex.Storage.Adapter - alias Deployex.{Configuration, State, Upgrade} + alias Deployex.{AppStatus, Configuration, Upgrade} require Logger @@ -47,7 +47,7 @@ defmodule Deployex.Storage.Local do download_path = "/tmp/#{monitored_app}/" <> storage_path - State.clear_new() + AppStatus.clear_new() {"", 0} = System.cmd("tar", [ @@ -58,7 +58,7 @@ defmodule Deployex.Storage.Local do Configuration.new_path() ]) - Upgrade.check(download_path, State.current_version(), version) + Upgrade.check(download_path, AppStatus.current_version(), version) end ### ========================================================================== diff --git a/lib/deployex/storage/s3.ex b/lib/deployex/storage/s3.ex index b69d6e1..4294cf0 100644 --- a/lib/deployex/storage/s3.ex +++ b/lib/deployex/storage/s3.ex @@ -5,7 +5,7 @@ defmodule Deployex.Storage.S3 do @behaviour Deployex.Storage.Adapter - alias Deployex.{Configuration, State, Upgrade} + alias Deployex.{AppStatus, Configuration, Upgrade} require Logger @@ -47,7 +47,7 @@ defmodule Deployex.Storage.S3 do |> ExAws.S3.download_file(s3_path, download_path) |> ExAws.request() - State.clear_new() + AppStatus.clear_new() {"", 0} = System.cmd("tar", [ @@ -58,7 +58,7 @@ defmodule Deployex.Storage.S3 do Configuration.new_path() ]) - Upgrade.check(download_path, State.current_version(), version) + Upgrade.check(download_path, AppStatus.current_version(), version) after Briefly.cleanup() end diff --git a/lib/deployex_web.ex b/lib/deployex_web.ex new file mode 100644 index 0000000..fcc4041 --- /dev/null +++ b/lib/deployex_web.ex @@ -0,0 +1,114 @@ +defmodule DeployexWeb do + @moduledoc """ + The entrypoint for defining your web interface, such + as controllers, components, channels, and so on. + + This can be used in your application as: + + use DeployexWeb, :controller + use DeployexWeb, :html + + The definitions below will be executed for every controller, + component, etc, so keep them short and clean, focused + on imports, uses and aliases. + + Do NOT define functions inside the quoted expressions + below. Instead, define additional modules and import + those modules here. + """ + + def static_paths, do: ~w(assets fonts images favicon.ico robots.txt) + + def router do + quote do + use Phoenix.Router, helpers: false + + # Import common connection and controller functions to use in pipelines + import Plug.Conn + import Phoenix.Controller + import Phoenix.LiveView.Router + end + end + + def channel do + quote do + use Phoenix.Channel + end + end + + def controller do + quote do + use Phoenix.Controller, + formats: [:html, :json], + layouts: [html: DeployexWeb.Layouts] + + import Plug.Conn + import DeployexWeb.Gettext + + unquote(verified_routes()) + end + end + + def live_view do + quote do + use Phoenix.LiveView, + layout: {DeployexWeb.Layouts, :app} + + unquote(html_helpers()) + defguard is_connected?(socket) when socket.transport_pid != nil + end + end + + def live_component do + quote do + use Phoenix.LiveComponent + + unquote(html_helpers()) + end + end + + def html do + quote do + use Phoenix.Component + + # Import convenience functions from controllers + import Phoenix.Controller, + only: [get_csrf_token: 0, view_module: 1, view_template: 1] + + # Include general helpers for rendering HTML + unquote(html_helpers()) + end + end + + defp html_helpers do + quote do + # HTML escaping functionality + import Phoenix.HTML + # Core UI components and translation + import DeployexWeb.CoreComponents + import DeployexWeb.Gettext + + # Shortcut for generating JS commands + alias Phoenix.LiveView.JS + + # Routes generation with the ~p sigil + unquote(verified_routes()) + end + end + + def verified_routes do + quote do + use Phoenix.VerifiedRoutes, + endpoint: DeployexWeb.Endpoint, + router: DeployexWeb.Router, + statics: DeployexWeb.static_paths() + end + end + + @doc """ + When used, dispatch to the appropriate controller/live_view/etc. + """ + defmacro __using__(which) when is_atom(which) do + apply(__MODULE__, which, []) + end +end diff --git a/lib/deployex_web/components/core_components.ex b/lib/deployex_web/components/core_components.ex new file mode 100644 index 0000000..ac70dde --- /dev/null +++ b/lib/deployex_web/components/core_components.ex @@ -0,0 +1,677 @@ +defmodule DeployexWeb.CoreComponents do + @moduledoc """ + Provides core UI components. + + At first glance, this module may seem daunting, but its goal is to provide + core building blocks for your application, such as modals, tables, and + forms. The components consist mostly of markup and are well-documented + with doc strings and declarative assigns. You may customize and style + them in any way you want, based on your application growth and needs. + + The default components use Tailwind CSS, a utility-first CSS framework. + See the [Tailwind CSS documentation](https://tailwindcss.com) to learn + how to customize them or feel free to swap in another framework altogether. + + Icons are provided by [heroicons](https://heroicons.com). See `icon/1` for usage. + """ + use Phoenix.Component + + alias Phoenix.HTML.Form + alias Phoenix.LiveView.JS + import DeployexWeb.Gettext + + @doc """ + Renders a modal. + + ## Examples + + <.modal id="confirm-modal"> + This is a modal. + + + JS commands may be passed to the `:on_cancel` to configure + the closing/cancel event, for example: + + <.modal id="confirm" on_cancel={JS.navigate(~p"/posts")}> + This is another modal. + + + """ + attr :id, :string, required: true + attr :show, :boolean, default: false + attr :on_cancel, JS, default: %JS{} + slot :inner_block, required: true + + def modal(assigns) do + ~H""" + + """ + end + + def input(%{type: "select"} = assigns) do + ~H""" +
+ <.label for={@id}><%= @label %> + + <.error :for={msg <- @errors}><%= msg %> +
+ """ + end + + def input(%{type: "textarea"} = assigns) do + ~H""" +
+ <.label for={@id}><%= @label %> + + <.error :for={msg <- @errors}><%= msg %> +
+ """ + end + + # All other inputs text, datetime-local, url, password, etc. are handled here... + def input(assigns) do + ~H""" +
+ <.label for={@id}><%= @label %> + + <.error :for={msg <- @errors}><%= msg %> +
+ """ + end + + @doc """ + Renders a label. + """ + attr :for, :string, default: nil + slot :inner_block, required: true + + def label(assigns) do + ~H""" + + """ + end + + @doc """ + Generates a generic error message. + """ + slot :inner_block, required: true + + def error(assigns) do + ~H""" +

+ <.icon name="hero-exclamation-circle-mini" class="mt-0.5 h-5 w-5 flex-none" /> + <%= render_slot(@inner_block) %> +

+ """ + end + + @doc """ + Renders a header with title. + """ + attr :class, :string, default: nil + + slot :inner_block, required: true + slot :subtitle + slot :actions + + def header(assigns) do + ~H""" +
+
+

+ <%= render_slot(@inner_block) %> +

+

+ <%= render_slot(@subtitle) %> +

+
+
<%= render_slot(@actions) %>
+
+ """ + end + + @doc ~S""" + Renders a table with generic styling. + + ## Examples + + <.table id="users" rows={@users}> + <:col :let={user} label="id"><%= user.id %> + <:col :let={user} label="username"><%= user.username %> + + """ + attr :id, :string, required: true + attr :rows, :list, required: true + attr :row_id, :any, default: nil, doc: "the function for generating the row id" + attr :row_click, :any, default: nil, doc: "the function for handling phx-click on each row" + + attr :row_item, :any, + default: &Function.identity/1, + doc: "the function for mapping each row before calling the :col and :action slots" + + slot :col, required: true do + attr :label, :string + end + + slot :action, doc: "the slot for showing user actions in the last table column" + + def table(assigns) do + assigns = + with %{rows: %Phoenix.LiveView.LiveStream{}} <- assigns do + assign(assigns, row_id: assigns.row_id || fn {id, _item} -> id end) + end + + ~H""" +
+ + + + + + + + + + + + + +
<%= col[:label] %> + <%= gettext("Actions") %> +
+
+ + + <%= render_slot(col, @row_item.(row)) %> + +
+ 		+
+ + + <%= render_slot(action, @row_item.(row)) %> + +
+
+
+ """ + end + + @doc """ + Renders a data list. + + ## Examples + + <.list> + <:item title="Title"><%= @post.title %> + <:item title="Views"><%= @post.views %> + + """ + slot :item, required: true do + attr :title, :string, required: true + end + + def list(assigns) do + ~H""" +
+
+
+
<%= item.title %>
+
<%= render_slot(item) %>
+
+
+
+ """ + end + + @doc """ + Renders a back navigation link. + + ## Examples + + <.back navigate={~p"/posts"}>Back to posts + """ + attr :navigate, :any, required: true + slot :inner_block, required: true + + def back(assigns) do + ~H""" +
+ <.link + navigate={@navigate} + class="text-sm font-semibold leading-6 text-zinc-900 hover:text-zinc-700" + > + <.icon name="hero-arrow-left-solid" class="h-3 w-3" /> + <%= render_slot(@inner_block) %> + +
+ """ + end + + @doc """ + Renders a [Heroicon](https://heroicons.com). + + Heroicons come in three styles โ€“ outline, solid, and mini. + By default, the outline style is used, but solid and mini may + be applied by using the `-solid` and `-mini` suffix. + + You can customize the size and colors of the icons by setting + width, height, and background color classes. + + Icons are extracted from the `deps/heroicons` directory and bundled within + your compiled app.css by the plugin in your `assets/tailwind.config.js`. + + ## Examples + + <.icon name="hero-x-mark-solid" /> + <.icon name="hero-arrow-path" class="ml-1 w-3 h-3 animate-spin" /> + """ + attr :name, :string, required: true + attr :class, :string, default: nil + + def icon(%{name: "hero-" <> _} = assigns) do + ~H""" + + """ + end + + ## JS Commands + + def show(js \\ %JS{}, selector) do + JS.show(js, + to: selector, + transition: + {"transition-all transform ease-out duration-300", + "opacity-0 translate-y-4 sm:translate-y-0 sm:scale-95", + "opacity-100 translate-y-0 sm:scale-100"} + ) + end + + def hide(js \\ %JS{}, selector) do + JS.hide(js, + to: selector, + time: 200, + transition: + {"transition-all transform ease-in duration-200", + "opacity-100 translate-y-0 sm:scale-100", + "opacity-0 translate-y-4 sm:translate-y-0 sm:scale-95"} + ) + end + + def show_modal(js \\ %JS{}, id) when is_binary(id) do + js + |> JS.show(to: "##{id}") + |> JS.show( + to: "##{id}-bg", + transition: {"transition-all transform ease-out duration-300", "opacity-0", "opacity-100"} + ) + |> show("##{id}-container") + |> JS.add_class("overflow-hidden", to: "body") + |> JS.focus_first(to: "##{id}-content") + end + + def hide_modal(js \\ %JS{}, id) do + js + |> JS.hide( + to: "##{id}-bg", + transition: {"transition-all transform ease-in duration-200", "opacity-100", "opacity-0"} + ) + |> hide("##{id}-container") + |> JS.hide(to: "##{id}", transition: {"block", "block", "hidden"}) + |> JS.remove_class("overflow-hidden", to: "body") + |> JS.pop_focus() + end + + @doc """ + Translates an error message using gettext. + """ + def translate_error({msg, opts}) do + # When using gettext, we typically pass the strings we want + # to translate as a static argument: + # + # # Translate the number of files with plural rules + # dngettext("errors", "1 file", "%{count} files", count) + # + # However the error messages in our forms and APIs are generated + # dynamically, so we need to translate them by calling Gettext + # with our gettext backend as first argument. Translations are + # available in the errors.po file (as we use the "errors" domain). + if count = opts[:count] do + Gettext.dngettext(DeployexWeb.Gettext, "errors", msg, msg, count, opts) + else + Gettext.dgettext(DeployexWeb.Gettext, "errors", msg, opts) + end + end + + @doc """ + Translates the errors for a field from a keyword list of errors. + """ + def translate_errors(errors, field) when is_list(errors) do + for {^field, {msg, opts}} <- errors, do: translate_error({msg, opts}) + end +end diff --git a/lib/deployex_web/components/layouts.ex b/lib/deployex_web/components/layouts.ex new file mode 100644 index 0000000..5f82a65 --- /dev/null +++ b/lib/deployex_web/components/layouts.ex @@ -0,0 +1,14 @@ +defmodule DeployexWeb.Layouts do + @moduledoc """ + This module holds different layouts used by your application. + + See the `layouts` directory for all templates available. + The "root" layout is a skeleton rendered as part of the + application router. The "app" layout is set as the default + layout on both `use DeployexWeb, :controller` and + `use DeployexWeb, :live_view`. + """ + use DeployexWeb, :html + + embed_templates "layouts/*" +end diff --git a/lib/deployex_web/components/layouts/app.html.heex b/lib/deployex_web/components/layouts/app.html.heex new file mode 100644 index 0000000..ce2d5f5 --- /dev/null +++ b/lib/deployex_web/components/layouts/app.html.heex @@ -0,0 +1,88 @@ +
+
+
+
+ +
+
+
+ <.flash_group flash={@flash} /> + <%= @inner_content %> +
+
+
diff --git a/lib/deployex_web/components/layouts/root.html.heex b/lib/deployex_web/components/layouts/root.html.heex new file mode 100644 index 0000000..f4f0d53 --- /dev/null +++ b/lib/deployex_web/components/layouts/root.html.heex @@ -0,0 +1,17 @@ + + + + + + + <.live_title suffix=" ยท Monitoring Elixir Apps"> + <%= assigns[:page_title] || "Deployex" %> + + + + + + <%= @inner_content %> + + diff --git a/lib/deployex_web/controllers/error_html.ex b/lib/deployex_web/controllers/error_html.ex new file mode 100644 index 0000000..6e76c6b --- /dev/null +++ b/lib/deployex_web/controllers/error_html.ex @@ -0,0 +1,24 @@ +defmodule DeployexWeb.ErrorHTML do + @moduledoc """ + This module is invoked by your endpoint in case of errors on HTML requests. + + See config/config.exs. + """ + use DeployexWeb, :html + + # If you want to customize your error pages, + # uncomment the embed_templates/1 call below + # and add pages to the error directory: + # + # * lib/deployex_web/controllers/error_html/404.html.heex + # * lib/deployex_web/controllers/error_html/500.html.heex + # + # embed_templates "error_html/*" + + # The default is to render a plain text page based on + # the template name. For example, "404.html" becomes + # "Not Found". + def render(template, _assigns) do + Phoenix.Controller.status_message_from_template(template) + end +end diff --git a/lib/deployex_web/controllers/error_json.ex b/lib/deployex_web/controllers/error_json.ex new file mode 100644 index 0000000..af08d66 --- /dev/null +++ b/lib/deployex_web/controllers/error_json.ex @@ -0,0 +1,21 @@ +defmodule DeployexWeb.ErrorJSON do + @moduledoc """ + This module is invoked by your endpoint in case of errors on JSON requests. + + See config/config.exs. + """ + + # If you want to customize a particular status code, + # you may add your own clauses, such as: + # + # def render("500.json", _assigns) do + # %{errors: %{detail: "Internal Server Error"}} + # end + + # By default, Phoenix returns the status message from + # the template name. For example, "404.json" becomes + # "Not Found". + def render(template, _assigns) do + %{errors: %{detail: Phoenix.Controller.status_message_from_template(template)}} + end +end diff --git a/lib/deployex_web/controllers/page_controller.ex b/lib/deployex_web/controllers/page_controller.ex new file mode 100644 index 0000000..ef4dbeb --- /dev/null +++ b/lib/deployex_web/controllers/page_controller.ex @@ -0,0 +1,9 @@ +defmodule DeployexWeb.PageController do + use DeployexWeb, :controller + + def home(conn, _params) do + # redirect to the default page, e. g., home or login + conn + |> redirect(to: ~p"/home") + end +end diff --git a/lib/deployex_web/controllers/page_html.ex b/lib/deployex_web/controllers/page_html.ex new file mode 100644 index 0000000..5665efa --- /dev/null +++ b/lib/deployex_web/controllers/page_html.ex @@ -0,0 +1,10 @@ +defmodule DeployexWeb.PageHTML do + @moduledoc """ + This module contains pages rendered by PageController. + + See the `page_html` directory for all templates available. + """ + use DeployexWeb, :html + + embed_templates "page_html/*" +end diff --git a/lib/deployex_web/controllers/page_html/home.html.heex b/lib/deployex_web/controllers/page_html/home.html.heex new file mode 100644 index 0000000..dc1820b --- /dev/null +++ b/lib/deployex_web/controllers/page_html/home.html.heex @@ -0,0 +1,222 @@ +<.flash_group flash={@flash} /> + +
+
+ +

+ Phoenix Framework + + v<%= Application.spec(:phoenix, :vsn) %> + +

+

+ Peace of mind from prototype to production. +

+

+ Build rich, interactive web applications quickly, with less code and fewer moving parts. Join our growing community of developers using Phoenix to craft APIs, HTML5 apps and more, for fun or at scale. +

+
+
+
+ + + + + + Guides & Docs + + + + + + + + Source Code + + + + + + + + Changelog + + +
+
+ + + + + +
+
+
+
+
diff --git a/lib/deployex_web/endpoint.ex b/lib/deployex_web/endpoint.ex new file mode 100644 index 0000000..50015d2 --- /dev/null +++ b/lib/deployex_web/endpoint.ex @@ -0,0 +1,52 @@ +defmodule DeployexWeb.Endpoint do + use Phoenix.Endpoint, otp_app: :deployex + + # The session will be stored in the cookie and signed, + # this means its contents can be read but not tampered with. + # Set :encryption_salt if you would also like to encrypt it. + @session_options [ + store: :cookie, + key: "_deployex_key", + signing_salt: "qSgrZpXd", + same_site: "Lax" + ] + + socket "/live", Phoenix.LiveView.Socket, + websocket: [connect_info: [session: @session_options]], + longpoll: [connect_info: [session: @session_options]] + + # Serve at "/" the static files from "priv/static" directory. + # + # You should set gzip to true if you are running phx.digest + # when deploying your static files in production. + plug Plug.Static, + at: "/", + from: :deployex, + gzip: false, + only: DeployexWeb.static_paths() + + # Code reloading can be explicitly enabled under the + # :code_reloader configuration of your endpoint. + if code_reloading? do + socket "/phoenix/live_reload/socket", Phoenix.LiveReloader.Socket + plug Phoenix.LiveReloader + plug Phoenix.CodeReloader + end + + plug Phoenix.LiveDashboard.RequestLogger, + param_key: "request_logger", + cookie_key: "request_logger" + + plug Plug.RequestId + plug Plug.Telemetry, event_prefix: [:phoenix, :endpoint] + + plug Plug.Parsers, + parsers: [:urlencoded, :multipart, :json], + pass: ["*/*"], + json_decoder: Phoenix.json_library() + + plug Plug.MethodOverride + plug Plug.Head + plug Plug.Session, @session_options + plug DeployexWeb.Router +end diff --git a/lib/deployex_web/gettext.ex b/lib/deployex_web/gettext.ex new file mode 100644 index 0000000..5ba7a0a --- /dev/null +++ b/lib/deployex_web/gettext.ex @@ -0,0 +1,24 @@ +defmodule DeployexWeb.Gettext do + @moduledoc """ + A module providing Internationalization with a gettext-based API. + + By using [Gettext](https://hexdocs.pm/gettext), + your module gains a set of macros for translations, for example: + + import DeployexWeb.Gettext + + # Simple translation + gettext("Here is the string to translate") + + # Plural translation + ngettext("Here is the string to translate", + "Here are the strings to translate", + 3) + + # Domain-based translation + dgettext("errors", "Here is the error message to translate") + + See the [Gettext Docs](https://hexdocs.pm/gettext) for detailed usage. + """ + use Gettext, otp_app: :deployex +end diff --git a/lib/deployex_web/live/coming_soon.ex b/lib/deployex_web/live/coming_soon.ex new file mode 100644 index 0000000..bfdeee5 --- /dev/null +++ b/lib/deployex_web/live/coming_soon.ex @@ -0,0 +1,22 @@ +defmodule DeployexWeb.ComingSoonLive do + use DeployexWeb, :live_view + + @impl true + def render(assigns) do + ~H""" +
+

+ Coming Soon +

+

+ We're working hard to bring you something amazing. Stay tuned! +

+
+ """ + end + + @impl true + def mount(_params, _session, socket) do + {:ok, socket} + end +end diff --git a/lib/deployex_web/live/components/app_cards.ex b/lib/deployex_web/live/components/app_cards.ex new file mode 100644 index 0000000..b173ba2 --- /dev/null +++ b/lib/deployex_web/live/components/app_cards.ex @@ -0,0 +1,130 @@ +defmodule DeployexWeb.Components.AppCards do + @moduledoc false + use Phoenix.Component + + attr :apps_data, :list, required: true + + def content(assigns) do + ~H""" +
+ <%= for app <- @apps_data do %> + + +
+
+
+
+
+ <% end %> +
+ """ + end + + defp ok_notok(assigns) do + ~H""" + <%= cond do %> + <% @status == :connected -> %> + + CONNECTED + + <% @status == :not_connected -> %> + + NOT CONNECTED + + <% @status == :supported -> %> + + SUPPORTED + + <% @status == :not_supported -> %> + + NOT SUPPORTED + + <% true -> %> + + NOT CONNECTED + + <% end %> + """ + end + + defp deployment(assigns) do + ~H""" + <%= if @deployment == "full_deployment" do %> + + FULL + + <% else %> + + HOT UPGRADE + + <% end %> + """ + end + + defp app_background(true, _status) do + "bg-gradient-to-r from-cyan-400 to-blue-400" + end + + defp app_background(_supervisor, :running) do + "bg-gradient-to-r from-cyan-200 to-yellow-100" + end + + defp app_background(_supervisor, _status) do + "bg-gray-400" + end + + defp version(assigns) do + ~H""" + <%= cond do %> + <% @status == :running and @version != nil -> %> +
+ <%= @version %> +
+ <% @status == :deploying and @version != nil -> %> +
+ <%= @version %> [deploying] +
+ <% @version == nil -> %> +
+ version not set +
+ <% true -> %> +
+ invalid state +
+ <% end %> + """ + end +end diff --git a/lib/deployex_web/live/home.ex b/lib/deployex_web/live/home.ex new file mode 100644 index 0000000..8275fb5 --- /dev/null +++ b/lib/deployex_web/live/home.ex @@ -0,0 +1,33 @@ +defmodule DeployexWeb.HomeLive do + use DeployexWeb, :live_view + + alias Deployex.AppStatus + + @impl true + def render(assigns) do + ~H""" +
+
+ +
+
+ """ + end + + @impl true + def mount(_params, _session, socket) when is_connected?(socket) do + Phoenix.PubSub.subscribe(Deployex.PubSub, AppStatus.listener_topic()) + + {:ok, assign(socket, :apps_data, :sys.get_state(AppStatus))} + end + + @impl true + def mount(_params, _session, socket) do + {:ok, assign(socket, :apps_data, [])} + end + + @impl true + def handle_info({:update_apps_data, apps_data}, socket) do + {:noreply, assign(socket, :apps_data, apps_data)} + end +end diff --git a/lib/deployex_web/router.ex b/lib/deployex_web/router.ex new file mode 100644 index 0000000..2007598 --- /dev/null +++ b/lib/deployex_web/router.ex @@ -0,0 +1,52 @@ +defmodule DeployexWeb.Router do + use DeployexWeb, :router + + pipeline :browser do + plug :accepts, ["html"] + plug :fetch_session + plug :fetch_live_flash + plug :put_root_layout, html: {DeployexWeb.Layouts, :root} + plug :protect_from_forgery + + plug :put_secure_browser_headers, %{ + "content-security-policy" => + "default-src 'self' 'unsafe-inline' opshealth.net *.opshealth.net data:;" + } + end + + pipeline :api do + plug :accepts, ["json"] + end + + scope "/", DeployexWeb do + pipe_through :browser + + live_session :default do + live "/", HomeLive, :index + live "/home", HomeLive, :index + live "/about", ComingSoonLive, :index + end + end + + # Other scopes may use custom stacks. + # scope "/api", DeployexWeb do + # pipe_through :api + # end + + # Enable LiveDashboard and Swoosh mailbox preview in development + if Application.compile_env(:deployex, :dev_routes) do + # If you want to use the LiveDashboard in production, you should put + # it behind authentication and allow only admins to access it. + # If your application does not have an admins-only section yet, + # you can use Plug.BasicAuth to set up some basic authentication + # as long as you are also using SSL (which you should anyway). + import Phoenix.LiveDashboard.Router + + scope "/dev" do + pipe_through :browser + + live_dashboard "/dashboard", metrics: DeployexWeb.Telemetry + forward "/mailbox", Plug.Swoosh.MailboxPreview + end + end +end diff --git a/lib/deployex_web/telemetry.ex b/lib/deployex_web/telemetry.ex new file mode 100644 index 0000000..cfe2a66 --- /dev/null +++ b/lib/deployex_web/telemetry.ex @@ -0,0 +1,69 @@ +defmodule DeployexWeb.Telemetry do + use Supervisor + import Telemetry.Metrics + + def start_link(arg) do + Supervisor.start_link(__MODULE__, arg, name: __MODULE__) + end + + @impl true + def init(_arg) do + children = [ + # Telemetry poller will execute the given period measurements + # every 10_000ms. Learn more here: https://hexdocs.pm/telemetry_metrics + {:telemetry_poller, measurements: periodic_measurements(), period: 10_000} + # Add reporters as children of your supervision tree. + # {Telemetry.Metrics.ConsoleReporter, metrics: metrics()} + ] + + Supervisor.init(children, strategy: :one_for_one) + end + + def metrics do + [ + # Phoenix Metrics + summary("phoenix.endpoint.start.system_time", + unit: {:native, :millisecond} + ), + summary("phoenix.endpoint.stop.duration", + unit: {:native, :millisecond} + ), + summary("phoenix.router_dispatch.start.system_time", + tags: [:route], + unit: {:native, :millisecond} + ), + summary("phoenix.router_dispatch.exception.duration", + tags: [:route], + unit: {:native, :millisecond} + ), + summary("phoenix.router_dispatch.stop.duration", + tags: [:route], + unit: {:native, :millisecond} + ), + summary("phoenix.socket_connected.duration", + unit: {:native, :millisecond} + ), + summary("phoenix.channel_joined.duration", + unit: {:native, :millisecond} + ), + summary("phoenix.channel_handled_in.duration", + tags: [:event], + unit: {:native, :millisecond} + ), + + # VM Metrics + summary("vm.memory.total", unit: {:byte, :kilobyte}), + summary("vm.total_run_queue_lengths.total"), + summary("vm.total_run_queue_lengths.cpu"), + summary("vm.total_run_queue_lengths.io") + ] + end + + defp periodic_measurements do + [ + # A module, function and arguments to be invoked periodically. + # This function must call :telemetry.execute/3 and a metric must be added above. + # {DeployexWeb, :count_users, []} + ] + end +end diff --git a/mix.exs b/mix.exs index 509dec5..c279a7c 100644 --- a/mix.exs +++ b/mix.exs @@ -4,8 +4,9 @@ defmodule Deployex.MixProject do def project do [ app: :deployex, - version: "0.1.0", + version: "0.2.0", elixir: "~> 1.15", + elixirc_paths: elixirc_paths(Mix.env()), start_permanent: Mix.env() == :prod, deps: deps(), docs: docs(), @@ -14,17 +15,23 @@ defmodule Deployex.MixProject do releases: [ deployex: [ include_executable_for: [:unix], - steps: [:assemble, :tar] + steps: [:assemble, :tar], + config_providers: [ + {Deployex.AwsSecretsManagerProvider, nil} + ] ] ], dialyzer: [ plt_add_apps: [:ex_unit, :mix], plt_file: {:no_warn, "priv/plts/dialyzer.plt"} - ] + ], + aliases: aliases() ] end - # Run "mix help compile.app" to learn about applications. + # Configuration for the OTP application. + # + # Type `mix help compile.app` for more information. def application do [ mod: {Deployex.Application, []}, @@ -59,20 +66,67 @@ defmodule Deployex.MixProject do ] end - # Run "mix help deps" to learn about dependencies. + # Specifies which paths to compile per environment. + defp elixirc_paths(:test), do: ["lib", "test/support"] + defp elixirc_paths(_), do: ["lib"] + + # Specifies your project dependencies. + # + # Type `mix help deps` for examples and options. defp deps do [ + {:phoenix, "~> 1.7.12"}, + {:phoenix_html, "~> 4.0"}, + {:phoenix_live_reload, "~> 1.2", only: :dev}, + {:phoenix_live_view, "~> 0.20.2"}, + {:floki, ">= 0.30.0", only: :test}, + {:phoenix_live_dashboard, "~> 0.8.3"}, + {:esbuild, "~> 0.8", runtime: Mix.env() == :dev}, + {:tailwind, "~> 0.2", runtime: Mix.env() == :dev}, + {:heroicons, + github: "tailwindlabs/heroicons", + tag: "v2.1.1", + sparse: "optimized", + app: false, + compile: false, + depth: 1}, + {:swoosh, "~> 1.5"}, + {:finch, "~> 0.13"}, + {:telemetry_metrics, "~> 1.0"}, + {:telemetry_poller, "~> 1.0"}, + {:gettext, "~> 0.20"}, + {:jason, "~> 1.2"}, + {:dns_cluster, "~> 0.1.1"}, + {:bandit, "~> 1.2"}, {:briefly, "~> 0.4.1"}, {:configparser_ex, "~> 4.0"}, {:erlexec, "~> 2.0.6"}, - {:jason, "~> 1.2"}, {:ex_aws, "~> 2.1"}, {:ex_aws_s3, "~> 2.0"}, {:hackney, "~> 1.9"}, - {:sobelow, "~> 0.13", only: [:dev, :test], runtime: false}, {:credo, "~> 1.7", only: [:dev, :test], runtime: false}, - {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false}, - {:mix_audit, "~> 2.1", only: [:dev, :test], runtime: false} + {:mix_audit, "~> 2.1", only: [:dev, :test], runtime: false}, + {:sobelow, "~> 0.13", only: [:dev, :test], runtime: false}, + {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false} + ] + end + + # Aliases are shortcuts or tasks specific to the current project. + # For example, to install project dependencies and perform other setup tasks, run: + # + # $ mix setup + # + # See the documentation for `Mix` for more info on aliases. + defp aliases do + [ + setup: ["deps.get", "assets.setup", "assets.build"], + "assets.setup": ["tailwind.install --if-missing", "esbuild.install --if-missing"], + "assets.build": ["tailwind deployex", "esbuild deployex"], + "assets.deploy": [ + "tailwind deployex --minify", + "esbuild deployex --minify", + "phx.digest" + ] ] end end diff --git a/mix.lock b/mix.lock index cdad989..7a9100e 100644 --- a/mix.lock +++ b/mix.lock @@ -1,27 +1,56 @@ %{ + "bandit": {:hex, :bandit, "1.5.2", "ed0a41c43a9e529c670d0fd48371db4027e7b80d43b1942893e17deb8bed0540", [:mix], [{:hpax, "~> 0.1.1", [hex: :hpax, repo: "hexpm", optional: false]}, {:plug, "~> 1.14", [hex: :plug, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}, {:thousand_island, "~> 1.0", [hex: :thousand_island, repo: "hexpm", optional: false]}, {:websock, "~> 0.5", [hex: :websock, repo: "hexpm", optional: false]}], "hexpm", "35ddbdce7e8a2a3c6b5093f7299d70832a43ed2f4a1852885a61d334cab1b4ad"}, "briefly": {:hex, :briefly, "0.4.1", "c90c0511e64bde1fe8da7e244e14acf5bc78c3f6d033db778205e1fa2feafa5c", [:mix], [], "hexpm", "fc0cafcd19c4ed0d0906ae5cf627cc6ce76b8652a160c6bde0ab9d77304ebb0a"}, "bunt": {:hex, :bunt, "1.0.0", "081c2c665f086849e6d57900292b3a161727ab40431219529f13c4ddcf3e7a44", [:mix], [], "hexpm", "dc5f86aa08a5f6fa6b8096f0735c4e76d54ae5c9fa2c143e5a1fc7c1cd9bb6b5"}, + "castore": {:hex, :castore, "1.0.7", "b651241514e5f6956028147fe6637f7ac13802537e895a724f90bf3e36ddd1dd", [:mix], [], "hexpm", "da7785a4b0d2a021cd1292a60875a784b6caef71e76bf4917bdee1f390455cf5"}, "certifi": {:hex, :certifi, "2.12.0", "2d1cca2ec95f59643862af91f001478c9863c2ac9cb6e2f89780bfd8de987329", [:rebar3], [], "hexpm", "ee68d85df22e554040cdb4be100f33873ac6051387baf6a8f6ce82272340ff1c"}, "configparser_ex": {:hex, :configparser_ex, "4.0.0", "17e2b831cfa33a08c56effc610339b2986f0d82a9caa0ed18880a07658292ab6", [:mix], [], "hexpm", "02e6d1a559361a063cba7b75bc3eb2d6ad7e62730c551cc4703541fd11e65e5b"}, "credo": {:hex, :credo, "1.7.6", "b8f14011a5443f2839b04def0b252300842ce7388f3af177157c86da18dfbeea", [:mix], [{:bunt, "~> 0.2.1 or ~> 1.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2 or ~> 1.0", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "146f347fb9f8cbc5f7e39e3f22f70acbef51d441baa6d10169dd604bfbc55296"}, "dialyxir": {:hex, :dialyxir, "1.4.3", "edd0124f358f0b9e95bfe53a9fcf806d615d8f838e2202a9f430d59566b6b53b", [:mix], [{:erlex, ">= 0.2.6", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "bf2cfb75cd5c5006bec30141b131663299c661a864ec7fbbc72dfa557487a986"}, + "dns_cluster": {:hex, :dns_cluster, "0.1.3", "0bc20a2c88ed6cc494f2964075c359f8c2d00e1bf25518a6a6c7fd277c9b0c66", [:mix], [], "hexpm", "46cb7c4a1b3e52c7ad4cbe33ca5079fbde4840dedeafca2baf77996c2da1bc33"}, "erlex": {:hex, :erlex, "0.2.6", "c7987d15e899c7a2f34f5420d2a2ea0d659682c06ac607572df55a43753aa12e", [:mix], [], "hexpm", "2ed2e25711feb44d52b17d2780eabf998452f6efda104877a3881c2f8c0c0c75"}, "erlexec": {:hex, :erlexec, "2.0.6", "b7443121cfb8add8bc25e3db9c1fd79d14613bbc406984264a0bbc62f121f377", [:rebar3], [], "hexpm", "8c4ebc02449f838648d9854d1c4dc7257e57d4ea2098a7e6386348372085ab21"}, + "esbuild": {:hex, :esbuild, "0.8.1", "0cbf919f0eccb136d2eeef0df49c4acf55336de864e63594adcea3814f3edf41", [:mix], [{:castore, ">= 0.0.0", [hex: :castore, repo: "hexpm", optional: false]}, {:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "25fc876a67c13cb0a776e7b5d7974851556baeda2085296c14ab48555ea7560f"}, "ex_aws": {:hex, :ex_aws, "2.5.3", "9c2d05ba0c057395b12c7b5ca6267d14cdaec1d8e65bdf6481fe1fd245accfb4", [:mix], [{:configparser_ex, "~> 4.0", [hex: :configparser_ex, repo: "hexpm", optional: true]}, {:hackney, "~> 1.16", [hex: :hackney, repo: "hexpm", optional: true]}, {:jason, "~> 1.1", [hex: :jason, repo: "hexpm", optional: true]}, {:jsx, "~> 2.8 or ~> 3.0", [hex: :jsx, repo: "hexpm", optional: true]}, {:mime, "~> 1.2 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:sweet_xml, "~> 0.7", [hex: :sweet_xml, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4.3 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "67115f1d399d7ec4d191812ee565c6106cb4b1bbf19a9d4db06f265fd87da97e"}, "ex_aws_s3": {:hex, :ex_aws_s3, "2.5.3", "422468e5c3e1a4da5298e66c3468b465cfd354b842e512cb1f6fbbe4e2f5bdaf", [:mix], [{:ex_aws, "~> 2.0", [hex: :ex_aws, repo: "hexpm", optional: false]}, {:sweet_xml, ">= 0.0.0", [hex: :sweet_xml, repo: "hexpm", optional: true]}], "hexpm", "4f09dd372cc386550e484808c5ac5027766c8d0cd8271ccc578b82ee6ef4f3b8"}, + "expo": {:hex, :expo, "0.5.2", "beba786aab8e3c5431813d7a44b828e7b922bfa431d6bfbada0904535342efe2", [:mix], [], "hexpm", "8c9bfa06ca017c9cb4020fabe980bc7fdb1aaec059fd004c2ab3bff03b1c599c"}, "file_system": {:hex, :file_system, "1.0.0", "b689cc7dcee665f774de94b5a832e578bd7963c8e637ef940cd44327db7de2cd", [:mix], [], "hexpm", "6752092d66aec5a10e662aefeed8ddb9531d79db0bc145bb8c40325ca1d8536d"}, + "finch": {:hex, :finch, "0.18.0", "944ac7d34d0bd2ac8998f79f7a811b21d87d911e77a786bc5810adb75632ada4", [:mix], [{:castore, "~> 0.1 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: false]}, {:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:mint, "~> 1.3", [hex: :mint, repo: "hexpm", optional: false]}, {:nimble_options, "~> 0.4 or ~> 1.0", [hex: :nimble_options, repo: "hexpm", optional: false]}, {:nimble_pool, "~> 0.2.6 or ~> 1.0", [hex: :nimble_pool, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "69f5045b042e531e53edc2574f15e25e735b522c37e2ddb766e15b979e03aa65"}, + "floki": {:hex, :floki, "0.36.2", "a7da0193538c93f937714a6704369711998a51a6164a222d710ebd54020aa7a3", [:mix], [], "hexpm", "a8766c0bc92f074e5cb36c4f9961982eda84c5d2b8e979ca67f5c268ec8ed580"}, + "gettext": {:hex, :gettext, "0.24.0", "6f4d90ac5f3111673cbefc4ebee96fe5f37a114861ab8c7b7d5b30a1108ce6d8", [:mix], [{:expo, "~> 0.5.1", [hex: :expo, repo: "hexpm", optional: false]}], "hexpm", "bdf75cdfcbe9e4622dd18e034b227d77dd17f0f133853a1c73b97b3d6c770e8b"}, "hackney": {:hex, :hackney, "1.20.1", "8d97aec62ddddd757d128bfd1df6c5861093419f8f7a4223823537bad5d064e2", [:rebar3], [{:certifi, "~> 2.12.0", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "~> 6.1.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "~> 1.0.0", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "~> 1.1", [hex: :mimerl, repo: "hexpm", optional: false]}, {:parse_trans, "3.4.1", [hex: :parse_trans, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "~> 1.1.0", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}, {:unicode_util_compat, "~> 0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "fe9094e5f1a2a2c0a7d10918fee36bfec0ec2a979994cff8cfe8058cd9af38e3"}, + "heroicons": {:git, "https://github.com/tailwindlabs/heroicons.git", "88ab3a0d790e6a47404cba02800a6b25d2afae50", [tag: "v2.1.1", sparse: "optimized"]}, + "hpax": {:hex, :hpax, "0.1.2", "09a75600d9d8bbd064cdd741f21fc06fc1f4cf3d0fcc335e5aa19be1a7235c84", [:mix], [], "hexpm", "2c87843d5a23f5f16748ebe77969880e29809580efdaccd615cd3bed628a8c13"}, "idna": {:hex, :idna, "6.1.1", "8a63070e9f7d0c62eb9d9fcb360a7de382448200fbbd1b106cc96d3d8099df8d", [:rebar3], [{:unicode_util_compat, "~> 0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "92376eb7894412ed19ac475e4a86f7b413c1b9fbb5bd16dccd57934157944cea"}, "jason": {:hex, :jason, "1.4.1", "af1504e35f629ddcdd6addb3513c3853991f694921b1b9368b0bd32beb9f1b63", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "fbb01ecdfd565b56261302f7e1fcc27c4fb8f32d56eab74db621fc154604a7a1"}, "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm", "69b09adddc4f74a40716ae54d140f93beb0fb8978d8636eaded0c31b6f099f16"}, "mime": {:hex, :mime, "2.0.5", "dc34c8efd439abe6ae0343edbb8556f4d63f178594894720607772a041b04b02", [:mix], [], "hexpm", "da0d64a365c45bc9935cc5c8a7fc5e49a0e0f9932a761c55d6c52b142780a05c"}, "mimerl": {:hex, :mimerl, "1.3.0", "d0cd9fc04b9061f82490f6581e0128379830e78535e017f7780f37fea7545726", [:rebar3], [], "hexpm", "a1e15a50d1887217de95f0b9b0793e32853f7c258a5cd227650889b38839fe9d"}, + "mint": {:hex, :mint, "1.6.0", "88a4f91cd690508a04ff1c3e28952f322528934be541844d54e0ceb765f01d5e", [:mix], [{:castore, "~> 0.1.0 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}, {:hpax, "~> 0.1.1 or ~> 0.2.0", [hex: :hpax, repo: "hexpm", optional: false]}], "hexpm", "3c5ae85d90a5aca0a49c0d8b67360bbe407f3b54f1030a111047ff988e8fefaa"}, "mix_audit": {:hex, :mix_audit, "2.1.3", "c70983d5cab5dca923f9a6efe559abfb4ec3f8e87762f02bab00fa4106d17eda", [:make, :mix], [{:jason, "~> 1.1", [hex: :jason, repo: "hexpm", optional: false]}, {:yaml_elixir, "~> 2.9", [hex: :yaml_elixir, repo: "hexpm", optional: false]}], "hexpm", "8c3987100b23099aea2f2df0af4d296701efd031affb08d0746b2be9e35988ec"}, + "nimble_options": {:hex, :nimble_options, "1.1.0", "3b31a57ede9cb1502071fade751ab0c7b8dbe75a9a4c2b5bbb0943a690b63172", [:mix], [], "hexpm", "8bbbb3941af3ca9acc7835f5655ea062111c9c27bcac53e004460dfd19008a99"}, + "nimble_pool": {:hex, :nimble_pool, "1.1.0", "bf9c29fbdcba3564a8b800d1eeb5a3c58f36e1e11d7b7fb2e084a643f645f06b", [:mix], [], "hexpm", "af2e4e6b34197db81f7aad230c1118eac993acc0dae6bc83bac0126d4ae0813a"}, "parse_trans": {:hex, :parse_trans, "3.4.1", "6e6aa8167cb44cc8f39441d05193be6e6f4e7c2946cb2759f015f8c56b76e5ff", [:rebar3], [], "hexpm", "620a406ce75dada827b82e453c19cf06776be266f5a67cff34e1ef2cbb60e49a"}, + "phoenix": {:hex, :phoenix, "1.7.12", "1cc589e0eab99f593a8aa38ec45f15d25297dd6187ee801c8de8947090b5a9d3", [:mix], [{:castore, ">= 0.0.0", [hex: :castore, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:phoenix_pubsub, "~> 2.1", [hex: :phoenix_pubsub, repo: "hexpm", optional: false]}, {:phoenix_template, "~> 1.0", [hex: :phoenix_template, repo: "hexpm", optional: false]}, {:phoenix_view, "~> 2.0", [hex: :phoenix_view, repo: "hexpm", optional: true]}, {:plug, "~> 1.14", [hex: :plug, repo: "hexpm", optional: false]}, {:plug_cowboy, "~> 2.7", [hex: :plug_cowboy, repo: "hexpm", optional: true]}, {:plug_crypto, "~> 1.2 or ~> 2.0", [hex: :plug_crypto, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}, {:websock_adapter, "~> 0.5.3", [hex: :websock_adapter, repo: "hexpm", optional: false]}], "hexpm", "d646192fbade9f485b01bc9920c139bfdd19d0f8df3d73fd8eaf2dfbe0d2837c"}, + "phoenix_html": {:hex, :phoenix_html, "4.1.1", "4c064fd3873d12ebb1388425a8f2a19348cef56e7289e1998e2d2fa758aa982e", [:mix], [], "hexpm", "f2f2df5a72bc9a2f510b21497fd7d2b86d932ec0598f0210fed4114adc546c6f"}, + "phoenix_live_dashboard": {:hex, :phoenix_live_dashboard, "0.8.3", "7ff51c9b6609470f681fbea20578dede0e548302b0c8bdf338b5a753a4f045bf", [:mix], [{:ecto, "~> 3.6.2 or ~> 3.7", [hex: :ecto, repo: "hexpm", optional: true]}, {:ecto_mysql_extras, "~> 0.5", [hex: :ecto_mysql_extras, repo: "hexpm", optional: true]}, {:ecto_psql_extras, "~> 0.7", [hex: :ecto_psql_extras, repo: "hexpm", optional: true]}, {:ecto_sqlite3_extras, "~> 1.1.7 or ~> 1.2.0", [hex: :ecto_sqlite3_extras, repo: "hexpm", optional: true]}, {:mime, "~> 1.6 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:phoenix_live_view, "~> 0.19 or ~> 1.0", [hex: :phoenix_live_view, repo: "hexpm", optional: false]}, {:telemetry_metrics, "~> 0.6 or ~> 1.0", [hex: :telemetry_metrics, repo: "hexpm", optional: false]}], "hexpm", "f9470a0a8bae4f56430a23d42f977b5a6205fdba6559d76f932b876bfaec652d"}, + "phoenix_live_reload": {:hex, :phoenix_live_reload, "1.5.3", "f2161c207fda0e4fb55165f650f7f8db23f02b29e3bff00ff7ef161d6ac1f09d", [:mix], [{:file_system, "~> 0.3 or ~> 1.0", [hex: :file_system, repo: "hexpm", optional: false]}, {:phoenix, "~> 1.4", [hex: :phoenix, repo: "hexpm", optional: false]}], "hexpm", "b4ec9cd73cb01ff1bd1cac92e045d13e7030330b74164297d1aee3907b54803c"}, + "phoenix_live_view": {:hex, :phoenix_live_view, "0.20.14", "70fa101aa0539e81bed4238777498f6215e9dda3461bdaa067cad6908110c364", [:mix], [{:floki, "~> 0.36", [hex: :floki, repo: "hexpm", optional: true]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:phoenix, "~> 1.6.15 or ~> 1.7.0", [hex: :phoenix, repo: "hexpm", optional: false]}, {:phoenix_html, "~> 3.3 or ~> 4.0", [hex: :phoenix_html, repo: "hexpm", optional: false]}, {:phoenix_template, "~> 1.0", [hex: :phoenix_template, repo: "hexpm", optional: false]}, {:phoenix_view, "~> 2.0", [hex: :phoenix_view, repo: "hexpm", optional: true]}, {:plug, "~> 1.15", [hex: :plug, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4.2 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "82f6d006c5264f979ed5eb75593d808bbe39020f20df2e78426f4f2d570e2402"}, + "phoenix_pubsub": {:hex, :phoenix_pubsub, "2.1.3", "3168d78ba41835aecad272d5e8cd51aa87a7ac9eb836eabc42f6e57538e3731d", [:mix], [], "hexpm", "bba06bc1dcfd8cb086759f0edc94a8ba2bc8896d5331a1e2c2902bf8e36ee502"}, + "phoenix_template": {:hex, :phoenix_template, "1.0.4", "e2092c132f3b5e5b2d49c96695342eb36d0ed514c5b252a77048d5969330d639", [:mix], [{:phoenix_html, "~> 2.14.2 or ~> 3.0 or ~> 4.0", [hex: :phoenix_html, repo: "hexpm", optional: true]}], "hexpm", "2c0c81f0e5c6753faf5cca2f229c9709919aba34fab866d3bc05060c9c444206"}, + "plug": {:hex, :plug, "1.15.3", "712976f504418f6dff0a3e554c40d705a9bcf89a7ccef92fc6a5ef8f16a30a97", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:plug_crypto, "~> 1.1.1 or ~> 1.2 or ~> 2.0", [hex: :plug_crypto, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4.3 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "cc4365a3c010a56af402e0809208873d113e9c38c401cabd88027ef4f5c01fd2"}, + "plug_crypto": {:hex, :plug_crypto, "2.1.0", "f44309c2b06d249c27c8d3f65cfe08158ade08418cf540fd4f72d4d6863abb7b", [:mix], [], "hexpm", "131216a4b030b8f8ce0f26038bc4421ae60e4bb95c5cf5395e1421437824c4fa"}, "sobelow": {:hex, :sobelow, "0.13.0", "218afe9075904793f5c64b8837cc356e493d88fddde126a463839351870b8d1e", [:mix], [{:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "cd6e9026b85fc35d7529da14f95e85a078d9dd1907a9097b3ba6ac7ebbe34a0d"}, "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.7", "354c321cf377240c7b8716899e182ce4890c5938111a1296add3ec74cf1715df", [:make, :mix, :rebar3], [], "hexpm", "fe4c190e8f37401d30167c8c405eda19469f34577987c76dde613e838bbc67f8"}, + "swoosh": {:hex, :swoosh, "1.16.7", "9dd0c172b4519a023f58e94d3ea79480b469dd4c0cd5369fabfbfd2e39bf5545", [:mix], [{:bandit, ">= 1.0.0", [hex: :bandit, repo: "hexpm", optional: true]}, {:cowboy, "~> 1.1 or ~> 2.4", [hex: :cowboy, repo: "hexpm", optional: true]}, {:ex_aws, "~> 2.1", [hex: :ex_aws, repo: "hexpm", optional: true]}, {:finch, "~> 0.6", [hex: :finch, repo: "hexpm", optional: true]}, {:gen_smtp, "~> 0.13 or ~> 1.0", [hex: :gen_smtp, repo: "hexpm", optional: true]}, {:hackney, "~> 1.9", [hex: :hackney, repo: "hexpm", optional: true]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}, {:mail, "~> 0.2", [hex: :mail, repo: "hexpm", optional: true]}, {:mime, "~> 1.1 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:mua, "~> 0.1.0", [hex: :mua, repo: "hexpm", optional: true]}, {:multipart, "~> 0.4", [hex: :multipart, repo: "hexpm", optional: true]}, {:plug, "~> 1.9", [hex: :plug, repo: "hexpm", optional: true]}, {:plug_cowboy, ">= 1.0.0", [hex: :plug_cowboy, repo: "hexpm", optional: true]}, {:req, "~> 0.4 or ~> 1.0", [hex: :req, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4.2 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "21073982816cff3410e90c0d80ebfd5a0bf4839c7b39db20bc69a6df123bbf35"}, + "tailwind": {:hex, :tailwind, "0.2.2", "9e27288b568ede1d88517e8c61259bc214a12d7eed271e102db4c93fcca9b2cd", [:mix], [{:castore, ">= 0.0.0", [hex: :castore, repo: "hexpm", optional: false]}], "hexpm", "ccfb5025179ea307f7f899d1bb3905cd0ac9f687ed77feebc8f67bdca78565c4"}, "telemetry": {:hex, :telemetry, "1.2.1", "68fdfe8d8f05a8428483a97d7aab2f268aaff24b49e0f599faa091f1d4e7f61c", [:rebar3], [], "hexpm", "dad9ce9d8effc621708f99eac538ef1cbe05d6a874dd741de2e689c47feafed5"}, + "telemetry_metrics": {:hex, :telemetry_metrics, "1.0.0", "29f5f84991ca98b8eb02fc208b2e6de7c95f8bb2294ef244a176675adc7775df", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "f23713b3847286a534e005126d4c959ebcca68ae9582118ce436b521d1d47d5d"}, + "telemetry_poller": {:hex, :telemetry_poller, "1.1.0", "58fa7c216257291caaf8d05678c8d01bd45f4bdbc1286838a28c4bb62ef32999", [:rebar3], [{:telemetry, "~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "9eb9d9cbfd81cbd7cdd24682f8711b6e2b691289a0de6826e58452f28c103c8f"}, + "thousand_island": {:hex, :thousand_island, "1.3.5", "6022b6338f1635b3d32406ff98d68b843ba73b3aa95cfc27154223244f3a6ca5", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "2be6954916fdfe4756af3239fb6b6d75d0b8063b5df03ba76fd8a4c87849e180"}, "unicode_util_compat": {:hex, :unicode_util_compat, "0.7.0", "bc84380c9ab48177092f43ac89e4dfa2c6d62b40b8bd132b1059ecc7232f9a78", [:rebar3], [], "hexpm", "25eee6d67df61960cf6a794239566599b09e17e668d3700247bc498638152521"}, + "websock": {:hex, :websock, "0.5.3", "2f69a6ebe810328555b6fe5c831a851f485e303a7c8ce6c5f675abeb20ebdadc", [:mix], [], "hexpm", "6105453d7fac22c712ad66fab1d45abdf049868f253cf719b625151460b8b453"}, + "websock_adapter": {:hex, :websock_adapter, "0.5.6", "0437fe56e093fd4ac422de33bf8fc89f7bc1416a3f2d732d8b2c8fd54792fe60", [:mix], [{:bandit, ">= 0.6.0", [hex: :bandit, repo: "hexpm", optional: true]}, {:plug, "~> 1.14", [hex: :plug, repo: "hexpm", optional: false]}, {:plug_cowboy, "~> 2.6", [hex: :plug_cowboy, repo: "hexpm", optional: true]}, {:websock, "~> 0.5", [hex: :websock, repo: "hexpm", optional: false]}], "hexpm", "e04378d26b0af627817ae84c92083b7e97aca3121196679b73c73b99d0d133ea"}, "yamerl": {:hex, :yamerl, "0.10.0", "4ff81fee2f1f6a46f1700c0d880b24d193ddb74bd14ef42cb0bcf46e81ef2f8e", [:rebar3], [], "hexpm", "346adb2963f1051dc837a2364e4acf6eb7d80097c0f53cbdc3046ec8ec4b4e6e"}, "yaml_elixir": {:hex, :yaml_elixir, "2.9.0", "9a256da867b37b8d2c1ffd5d9de373a4fda77a32a45b452f1708508ba7bbcb53", [:mix], [{:yamerl, "~> 0.10", [hex: :yamerl, repo: "hexpm", optional: false]}], "hexpm", "0cb0e7d4c56f5e99a6253ed1a670ed0e39c13fc45a6da054033928607ac08dfc"}, } diff --git a/priv/gettext/en/LC_MESSAGES/errors.po b/priv/gettext/en/LC_MESSAGES/errors.po new file mode 100644 index 0000000..cdec3a1 --- /dev/null +++ b/priv/gettext/en/LC_MESSAGES/errors.po @@ -0,0 +1,11 @@ +## `msgid`s in this file come from POT (.pot) files. +## +## Do not add, change, or remove `msgid`s manually here as +## they're tied to the ones in the corresponding POT file +## (with the same domain). +## +## Use `mix gettext.extract --merge` or `mix gettext.merge` +## to merge POT files into PO files. +msgid "" +msgstr "" +"Language: en\n" diff --git a/priv/gettext/errors.pot b/priv/gettext/errors.pot new file mode 100644 index 0000000..d6f47fa --- /dev/null +++ b/priv/gettext/errors.pot @@ -0,0 +1,10 @@ +## This is a PO Template file. +## +## `msgid`s here are often extracted from source code. +## Add new translations manually only if they're dynamic +## translations that can't be statically extracted. +## +## Run `mix gettext.extract` to bring this file up to +## date. Leave `msgstr`s empty as changing them here has no +## effect: edit them in PO (`.po`) files instead. + diff --git a/priv/static/favicon.ico b/priv/static/favicon.ico new file mode 100644 index 0000000..7f372bf Binary files /dev/null and b/priv/static/favicon.ico differ diff --git a/priv/static/images/logo.svg b/priv/static/images/logo.svg new file mode 100644 index 0000000..9f26bab --- /dev/null +++ b/priv/static/images/logo.svg @@ -0,0 +1,6 @@ + diff --git a/priv/static/robots.txt b/priv/static/robots.txt new file mode 100644 index 0000000..26e06b5 --- /dev/null +++ b/priv/static/robots.txt @@ -0,0 +1,5 @@ +# See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file +# +# To ban all spiders from the entire site uncomment the next two lines: +# User-agent: * +# Disallow: / diff --git a/test/deployex_web/controllers/error_html_test.exs b/test/deployex_web/controllers/error_html_test.exs new file mode 100644 index 0000000..1dbfc09 --- /dev/null +++ b/test/deployex_web/controllers/error_html_test.exs @@ -0,0 +1,14 @@ +defmodule DeployexWeb.ErrorHTMLTest do + use DeployexWeb.ConnCase, async: true + + # Bring render_to_string/4 for testing custom views + import Phoenix.Template + + test "renders 404.html" do + assert render_to_string(DeployexWeb.ErrorHTML, "404", "html", []) == "Not Found" + end + + test "renders 500.html" do + assert render_to_string(DeployexWeb.ErrorHTML, "500", "html", []) == "Internal Server Error" + end +end diff --git a/test/deployex_web/controllers/error_json_test.exs b/test/deployex_web/controllers/error_json_test.exs new file mode 100644 index 0000000..d104a07 --- /dev/null +++ b/test/deployex_web/controllers/error_json_test.exs @@ -0,0 +1,12 @@ +defmodule DeployexWeb.ErrorJSONTest do + use DeployexWeb.ConnCase, async: true + + test "renders 404" do + assert DeployexWeb.ErrorJSON.render("404.json", %{}) == %{errors: %{detail: "Not Found"}} + end + + test "renders 500" do + assert DeployexWeb.ErrorJSON.render("500.json", %{}) == + %{errors: %{detail: "Internal Server Error"}} + end +end diff --git a/test/deployex_web/controllers/page_controller_test.exs b/test/deployex_web/controllers/page_controller_test.exs new file mode 100644 index 0000000..a88be96 --- /dev/null +++ b/test/deployex_web/controllers/page_controller_test.exs @@ -0,0 +1,8 @@ +defmodule DeployexWeb.PageControllerTest do + use DeployexWeb.ConnCase + + test "GET /", %{conn: conn} do + conn = get(conn, ~p"/about") + assert html_response(conn, 200) =~ "Coming Soon" + end +end diff --git a/test/support/conn_case.ex b/test/support/conn_case.ex new file mode 100644 index 0000000..6403587 --- /dev/null +++ b/test/support/conn_case.ex @@ -0,0 +1,37 @@ +defmodule DeployexWeb.ConnCase do + @moduledoc """ + This module defines the test case to be used by + tests that require setting up a connection. + + Such tests rely on `Phoenix.ConnTest` and also + import other functionality to make it easier + to build common data structures and query the data layer. + + Finally, if the test case interacts with the database, + we enable the SQL sandbox, so changes done to the database + are reverted at the end of every test. If you are using + PostgreSQL, you can even run database tests asynchronously + by setting `use DeployexWeb.ConnCase, async: true`, although + this option is not recommended for other databases. + """ + + use ExUnit.CaseTemplate + + using do + quote do + # The default endpoint for testing + @endpoint DeployexWeb.Endpoint + + use DeployexWeb, :verified_routes + + # Import conveniences for testing with connections + import Plug.Conn + import Phoenix.ConnTest + import DeployexWeb.ConnCase + end + end + + setup _tags do + {:ok, conn: Phoenix.ConnTest.build_conn()} + end +end