April 2021 Hubs Cloud Update

Dockerfile

@@ -1,5 +1,5 @@
 FROM elixir:1.5
-RUN apt-get update -qq && apt-get install -y inotify-tools nodejs nodejs-legacy
+RUN apt-get update -qq && apt-get install -y inotify-tools
 RUN curl -so- -L https://yarnpkg.com/install.sh | bash
 RUN mkdir /ret
 WORKDIR	/ret

Jenkinsfile

@@ -1,19 +1,5 @@
 import groovy.json.JsonOutput
 
-// From https://issues.jenkins-ci.org/browse/JENKINS-44231
-
-// Given arbitrary string returns a strongly escaped shell string literal.
-// I.e. it will be in single quotes which turns off interpolation of $(...), etc.
-// E.g.: 1'2\3\'4 5"6 (groovy string) -> '1'\''2\3\'\''4 5"6' (groovy string which can be safely pasted into shell command).
-def shellString(s) {
-  // Replace ' with '\'' (https://unix.stackexchange.com/a/187654/260156). Then enclose with '...'.
-  // 1) Why not replace \ with \\? Because '...' does not treat backslashes in a special way.
-  // 2) And why not use ANSI-C quoting? I.e. we could replace ' with \'
-  // and enclose using $'...' (https://stackoverflow.com/a/8254156/4839573).
-  // Because ANSI-C quoting is not yet supported by Dash (default shell in Ubuntu & Debian) (https://unix.stackexchange.com/a/371873).
-  '\'' + s.replace('\'', '\'\\\'\'') + '\''
-}
-
 pipeline {
   agent any
 
@@ -34,46 +20,65 @@ pipeline {
           /usr/bin/script --return -c \\\\"sudo /usr/bin/hab-docker-studio -k mozillareality run /bin/bash scripts/build.sh\\\\" /dev/null
         '''
 
-        sh 'sudo /usr/bin/hab-pkg-upload $(ls -rt results/*.hart | head -n 1)'
+        sh 'sudo /usr/bin/hab-pkg-upload $(ls -t results/*.hart | head -n 1)'
 
         script {
-            // Grab IDENT file and cat it from .hart
-            def s = $/eval 'ls -rt results/*.hart | head -n 1'/$
-            def hart = sh(returnStdout: true, script: "${s}").trim()
-            s = $/eval 'tail -n +6 ${hart} | xzcat | tar tf - | grep IDENT'/$
-            def identPath = sh(returnStdout: true, script: "${s}").trim()
-            s = $/eval 'tail -n +6 ${hart} | xzcat | tar xf - "${identPath}" -O'/$
-            def packageIdent = sh(returnStdout: true, script: "${s}").trim()
+          def poolHost = env.RET_DARK_POOL_HOST
+          def slackURL = env.SLACK_URL
+          def buildNumber = env.BUILD_NUMBER
+          def jobName = env.JOB_NAME
+          def disablePromoteToStable = env.DISABLE_PROMOTE_TO_STABLE
+          def showQAPromoteCommand = env.SHOW_QA_PROMOTE_COMMAND
+          def qaBuildsSlackChannel = env.QA_BUILDS_SLACK_CHANNEL
+
+          // Grab IDENT file and cat it from .hart
+          def s = $/eval 'ls -t results/*.hart | head -n 1'/$
+          def hart = sh(returnStdout: true, script: "${s}").trim()
+
+          s = $/eval 'tail -n +6 ${hart} | xzcat | tar tf - | grep IDENT'/$
+          def identPath = sh(returnStdout: true, script: "${s}").trim()
+
+          s = $/eval 'tail -n +6 ${hart} | xzcat | tar xf - "${identPath}" -O'/$
+          def packageIdent = sh(returnStdout: true, script: "${s}").trim()
+
+          def gitMessage = sh(returnStdout: true, script: "git log -n 1 --pretty=format:'[%an] %s'").trim()
+          def gitSha = sh(returnStdout: true, script: "git log -n 1 --pretty=format:'%h'").trim()
+
+          if (disablePromoteToStable == null || disablePromoteToStable == "") {
+            def retPool = sh(returnStdout: true, script: "curl https://${poolHost}/api/v1/meta | jq -r '.pool'").trim()
+            sh "sudo /usr/bin/hab-pkg-promote '${packageIdent}' '${retPool}'"
+            sh "sudo /usr/bin/hab-pkg-promote '${packageIdent}' 'stable'"
+
             def packageTimeVersion = packageIdent.tokenize('/')[3]
             def (major, minor, version) = packageIdent.tokenize('/')[2].tokenize('.')
             def retVersion = "${major}.${minor}.${packageTimeVersion}"
-            def poolHost = env.RET_DARK_POOL_HOST
-            def retPool = sh(returnStdout: true, script: "curl https://${poolHost}/api/v1/meta | jq -r '.pool'").trim()
+
             def retPoolIcon = retPool == 'earth' ? ':earth_americas:' : ':new_moon:'
 
-            def gitMessage = sh(returnStdout: true, script: "git log -n 1 --pretty=format:'[%an] %s'").trim()
-            def gitSha = sh(returnStdout: true, script: "git log -n 1 --pretty=format:'%h'").trim()
-            def slackURL = env.SLACK_URL
             def text = (
-              "*<http://localhost:8080/job/${env.JOB_NAME}/${env.BUILD_NUMBER}|#${env.BUILD_NUMBER}>* *${env.JOB_NAME}* " +
+              "*<http://localhost:8080/job/${jobName}/${buildNumber}|#${buildNumber}>* *${jobName}* " +
               "<https://bldr.habitat.sh/#/pkgs/${packageIdent}|${packageIdent}>\n" +
               "<https://github.com/mozilla/reticulum/commit/$gitSha|$gitSha> " +
               "Reticulum -> ${retPoolIcon} `${retPool}`: ```${gitSha} ${gitMessage}```\n" +
               "<https://smoke-hubs.mozilla.com/0zuesf6c6mf/smoke-test?required_ret_version=${retVersion}&required_ret_pool=${retPool}|Smoke Test> - to push:\n" +
               "`/mr ret deploy ${retVersion} ${retPool}`"
             )
-            def payload = 'payload=' + JsonOutput.toJson([
-              text      : text,
-              channel   : "#mr-builds",
-              username  : "buildbot",
-              icon_emoji: ":gift:"
-            ])
-            sh "sudo /usr/bin/hab-pkg-promote '${packageIdent}' '${retPool}'"
-            sh "sudo /usr/bin/hab-pkg-promote '${packageIdent}' 'stable'"
-            sh "curl -X POST --data-urlencode ${shellString(payload)} ${slackURL}"
+            sendSlackMessage(text, "#mr-builds", ":gift:", slackURL);
+          }
 
-            // Upload to ret depot after publishing to slack to minimize wait
-            sh 'sudo /usr/bin/hab-ret-pkg-upload $(ls -rt results/*.hart | head -n 1)'
+          // Upload to ret depot after publishing to slack to minimize wait
+          sh 'sudo /usr/bin/hab-ret-pkg-upload $(ls -t results/*.hart | head -n 1)'
+
+          if (showQAPromoteCommand == "true") {
+            def text = (
+              "*<http://localhost:8080/job/${jobName}/${buildNumber}|#${buildNumber}>* *${jobName}* " +
+              "<https://bldr.reticulum.io/#/pkgs/${packageIdent}|${packageIdent}>\n" +
+              "<https://github.com/mozilla/reticulum/commit/$gitSha|$gitSha> " +
+              "${packageIdent} built and uploaded - to promote:\n" +
+              "`/mr promote-ret-qa ${packageIdent}`"
+            )
+            sendSlackMessage(text, qaBuildsSlackChannel, ":gift:", slackURL);
+          }
         }
       }
     }
@@ -85,3 +90,27 @@ pipeline {
      }
    }
 }
+
+def sendSlackMessage(text, channel, icon, slackURL) {
+  def payload = 'payload=' + JsonOutput.toJson([
+    text      : text,
+    channel   : channel,
+    username  : "buildbot",
+    icon_emoji: icon
+  ])
+  sh "curl -X POST --data-urlencode ${shellString(payload)} ${slackURL}"
+}
+
+// From https://issues.jenkins-ci.org/browse/JENKINS-44231
+
+// Given arbitrary string returns a strongly escaped shell string literal.
+// I.e. it will be in single quotes which turns off interpolation of $(...), etc.
+// E.g.: 1'2\3\'4 5"6 (groovy string) -> '1'\''2\3\'\''4 5"6' (groovy string which can be safely pasted into shell command).
+def shellString(s) {
+  // Replace ' with '\'' (https://unix.stackexchange.com/a/187654/260156). Then enclose with '...'.
+  // 1) Why not replace \ with \\? Because '...' does not treat backslashes in a special way.
+  // 2) And why not use ANSI-C quoting? I.e. we could replace ' with \'
+  // and enclose using $'...' (https://stackoverflow.com/a/8254156/4839573).
+  // Because ANSI-C quoting is not yet supported by Dash (default shell in Ubuntu & Debian) (https://unix.stackexchange.com/a/371873).
+  '\'' + s.replace('\'', '\'\\\'\'') + '\''
+}

README.md

@@ -8,7 +8,14 @@ A hybrid game networking and web API server, focused on Social Mixed Reality.
 
 #### PostgreSQL (recommended version 11.x):
 
-Linux: Use your package manager
+Linux:
+
+On Ubuntu, you can use
+```
+apt install postgresql
+```
+
+Otherwise, consult your package manager of choice for other Linux distributions
 
 Windows: https://www.postgresql.org/download/windows/
 
@@ -30,8 +37,9 @@ Run the following commands at the root of the reticulum directory:
 
 1. `mix deps.get`
 2. `mix ecto.create`
-   - If step 2 fails, you may need to change the password for the `postgres` role to match the password configured `dev.exs`.
-   - From within the `psql` shell, enter `ALTER USER postgres WITH PASSWORD 'postgres';`
+    * If step 2 fails, you may need to change the password for the `postgres` role to match the password configured `dev.exs`.
+    * From within the `psql` shell, enter `ALTER USER postgres WITH PASSWORD 'postgres';`
+    * If you receive an error that the `ret_dev` database does not exist, (using psql again) enter `create database ret_dev;`
 3. from the `assets` directory, `npm install`
 4. From the project directory `mkdir -p storage/dev`
 
@@ -41,19 +49,22 @@ Run `scripts/run.sh` if you have the hubs secret repo cloned. Otherwise `iex -S
 
 ## Run Hubs Against a Local Reticulum Instance
 
-### 0. Dependencies
-
-[Install NodeJS](https://nodejs.org) if you haven't already. We recommend version 12 or above.
-
 ### 1. Setup the `hubs.local` hostname
 
 When running the full stack for Hubs (which includes Reticulum) locally it is necessary to add a `hosts` entry pointing `hubs.local` to your local server's IP.
 This will allow the CSP checks to pass that are served up by Reticulum so you can test the whole app. Note that you must also load hubs.local over https.
 
-Example:
+On MacOS or Linux:
 
+```bash
+nano /etc/hosts
 ```
-hubs.local 127.0.0.1
+
+From there, add a host alias
+
+Example:
+```bash
+127.0.0.1   hubs.local
 ```
 
 ### 2. Setting up the Hubs Repository
@@ -96,6 +107,17 @@ After you've started Reticulum for the first time you'll likely want to create a
 Ret.Account |> Ret.Repo.all() |> Enum.at(0) |> Ecto.Changeset.change(is_admin: true) |> Ret.Repo.update!()
 ```
 
+### 7. Start the Admin Portal server in local development mode
+
+When running locally, you will need to also run the admin portal, which routes to hubs.local:8989
+Using a separate terminal instance, navigate to the `hubs/admin` folder and use:
+```
+npm run local
+```
+
+You can now navigate to https://hubs.local:4000/admin to access the admin control panel
+
+
 ## Run Spoke Against a Local Reticulum Instance
 
 1. Follow the steps above to setup Hubs
@@ -125,3 +147,5 @@ default_janus_csp_rule =
 ```
    psql-userdb="host=hubs.local dbname=ret_dev user=postgres password=postgres options='-c search_path=coturn' connect_timeout=30"
 ```
+
+