From af4a8e0f88705fccb5003f04d843de67e62e41ab Mon Sep 17 00:00:00 2001
From: Jonathan <jonathan.johnson@dijure.com>
Date: Sun, 21 Nov 2021 20:21:08 -0500
Subject: [PATCH] Fixing container publish action. Refined command help. Added
 SOLVER_CONTEXT env override.

---
 .github/PULL_REQUEST_TEMPLATE.md              |  2 +-
 .github/workflows/ci-on-main.yaml             |  2 +-
 roadmap.md                                    | 19 ++++++++---------
 src/main/docker/Dockerfile.native             |  2 ++
 src/main/docker/Dockerfile.native-distroless  |  2 ++
 .../com/katacoda/solver/SolverTopCommand.java |  7 +++----
 .../katacoda/solver/models/Configuration.java | 21 +++++++++++++------
 .../com/katacoda/solver/models/Hints.java     |  2 +-
 .../com/katacoda/solver/models/Solutions.java |  4 ++--
 .../katacoda/solver/models/Verifications.java |  4 ++--
 .../solver/subcommands/SubcommandAll.java     |  4 ++--
 .../solver/subcommands/SubcommandCheck.java   |  4 ++--
 .../solver/subcommands/SubcommandCreate.java  |  4 ++--
 .../solver/subcommands/SubcommandHint.java    |  2 +-
 .../solver/subcommands/SubcommandNext.java    |  4 ++--
 .../solver/subcommands/SubcommandReset.java   |  4 ++--
 .../subcommands/SubcommandSolutions.java      | 10 ++++-----
 .../solver/subcommands/SubcommandStatus.java  |  2 +-
 .../solver/subcommands/SubcommandUntil.java   |  2 +-
 .../solver/subcommands/SubcommandVerify.java  |  4 ++--
 20 files changed, 58 insertions(+), 47 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index f4908a8..6656852 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -5,7 +5,7 @@
 - (List changes made in this PR)
 - (List changes made in this PR)
 
-See [Creating Chalenges](https://www.katacoda.community/challenges/challenges.html) and how to use this tool with in the [Challenges Solver Utility](https://www.katacoda.community/challenges/challenges-solver.html).
+See [Creating Chalenges](https://www.katacoda.community/challenges/challenges.html) and how to use this tool within the [Challenges Solver Utility](https://www.katacoda.community/challenges/challenges-solver.html).
 
 <!---
 (Be sure to label branch with `major`, `minor`, or `patch` labels!)
diff --git a/.github/workflows/ci-on-main.yaml b/.github/workflows/ci-on-main.yaml
index c7d5cbc..66527c6 100644
--- a/.github/workflows/ci-on-main.yaml
+++ b/.github/workflows/ci-on-main.yaml
@@ -111,7 +111,7 @@ jobs:
       - name: Build Container Image
         run: |
           IMAGE=ghcr.io/javajon/solver:${{ steps.semver_bump_data.outputs.version }}
-          docker build src/main/docker/Dockerfile.native-distroless --tag $IMAGE
+          docker build -f src/main/docker/Dockerfile.native-distroless --tag $IMAGE .
           docker run $IMAGE
           docker push $IMAGE
 
diff --git a/roadmap.md b/roadmap.md
index 534e93e..4df4a71 100644
--- a/roadmap.md
+++ b/roadmap.md
@@ -4,13 +4,12 @@ Upcoming considerations to improve the tool:
 
 ## Near term feature goals and issues
 
-- Container image for solver
-- More archetypes for `solver create`, currently just Linux, but `basic` should be next.
-- OSX and Windows native binary on the release page
+- More archetypes for `solver create`, currently just `linux`, `basic` may be next.
 - Test command line for oddball values, eg. solver all when solutions not decrypted.
 - Enhance help descriptions for each command
 - Add more unit testing
 - Add .cypress tests to archetypes
+- OSX and Windows native binary on the release page
 
 The current commands for Solver are marked with their implementation and testing status:
 
@@ -18,18 +17,18 @@ The current commands for Solver are marked with their implementation and testing
 |---------|-----------------------|-------------|
 | ✔       | -h, --help           | Show this help message and exit. |
 | ✔       | -V, --version        | Print version information and exit. |
-| ✔       | solutions, sol       | Install solutions for testing. Requires authoring passcode placed in challenge source repo. |
+| ✔       | solutions, sol       | Install solutions for testing. Requires authoring passcode. |
 | ✔       | next                 | Solve current task and on success advance current task number |    
 | ✔       | all                  | Solve all remaining tasks |
 | ✔       | until                | Solve all tasks from current task until reaching given task number |
 | ✔       | verify               | Verify task number is complete |
-| ✔       | hint                 | Peak at hint ID for the task number. Omitting # assumes current task |
-| ✔       | view                 | Reveal the verifications, hints, and solutions for a task. |
+| ✔       | hint                 | Get hint give a task number and hint number |
+| ✔       | view                 | Reveal the verifications, hints, and solutions for a task |
 | ✔       | reset                | Clear task tracker so next task is assumed to be 1 |
-| ✔       | status               | Get the current step and hint. |
-| ✔       | request_hint         | internal call |
-| ✔       | request_advance_task | internal call |
-| ✔       | create               | Create any missing files that are needed by Solver. Will not overwrite. Must be authoring. |
+| ✔       | status               | Get the next task to solve |
+| ✔       | request_hint         | internal call by hint.sh only |
+| ✔       | request_advance_task | internal call by verify.sh only |
+| ✔       | create               | Create a Challenge project from the given archetype when in authoring context |
 | 🤔 todo  | check                | Verify the required artifacts for the challenge are present and valid. Can check authoring and Challenge environments. |
 
 ## Longer-term feature goals
diff --git a/src/main/docker/Dockerfile.native b/src/main/docker/Dockerfile.native
index 59058fd..f7c26bc 100644
--- a/src/main/docker/Dockerfile.native
+++ b/src/main/docker/Dockerfile.native
@@ -23,5 +23,7 @@ COPY --chown=1001:root build/*-runner /work/application
 
 USER 1001
 
+ENV SOLVER_CONTEXT=challenge
+
 ENTRYPOINT ["./application"]
 CMD ["--help"]
diff --git a/src/main/docker/Dockerfile.native-distroless b/src/main/docker/Dockerfile.native-distroless
index 03d4cd0..45e7331 100644
--- a/src/main/docker/Dockerfile.native-distroless
+++ b/src/main/docker/Dockerfile.native-distroless
@@ -19,5 +19,7 @@ COPY build/*-runner /application
 
 USER nonroot
 
+ENV SOLVER_CONTEXT=challenge
+
 ENTRYPOINT ["./application"]
 CMD ["--help"]
diff --git a/src/main/java/com/katacoda/solver/SolverTopCommand.java b/src/main/java/com/katacoda/solver/SolverTopCommand.java
index 4061bc7..5ee1730 100644
--- a/src/main/java/com/katacoda/solver/SolverTopCommand.java
+++ b/src/main/java/com/katacoda/solver/SolverTopCommand.java
@@ -7,8 +7,8 @@
 @TopCommand
 @Command(name = "solver", mixinStandardHelpOptions = true,
         versionProvider = com.katacoda.solver.models.VersionProvider.class,
-        description = "Solves each task in the challenge given the provided functions for the task solutions and verifications.\n",
-        footer = "\nNormally, tasks are solved sequentially using 'next'. However, some tasks can be skipped if a task is optional. Before publication, the 'all' command should solve all tasks without error.",
+        description = "An authoring tool and utility for the O'Reilly Challenges framework. Verify tasks, provide hints, and solves tasks in the Challenge. Works with the provided hints.md, verifications.sh, and solutions.sh as the supporting sources.\n",
+        footer = "\nOnce solutions have been decripted command such as next, all, and until will solve the challenge. Before publication, the 'all' command must solve all tasks without error.",
         subcommands = {
                 // Primary interactive commands
                 SubcommandSolutions.class,
@@ -32,6 +32,5 @@
                 SubcommandRequestHint.class
         })
 
-
 public class SolverTopCommand {
-}
+}
\ No newline at end of file
diff --git a/src/main/java/com/katacoda/solver/models/Configuration.java b/src/main/java/com/katacoda/solver/models/Configuration.java
index c281f78..5e0fa20 100644
--- a/src/main/java/com/katacoda/solver/models/Configuration.java
+++ b/src/main/java/com/katacoda/solver/models/Configuration.java
@@ -95,22 +95,31 @@ public static boolean isChallengeComplete(int task) {
         return task <= 0;
     }
 
-    public enum Environment {
+    public enum ContextType {
         development,
         authoring,
         challenge
     }
 
-    public static Environment getEnvironment() {
+    public static ContextType getContextType() {
         if (Path.of("/usr", "local", "bin", "challenge.sh").toFile().exists()) {
-            return Environment.challenge;
+            return ContextType.challenge;
         }
 
-        if (new File("gradlew").exists()) {
-            return Environment.development;
+        if (new File("index.json").exists()) {
+            return ContextType.authoring;
         }
 
-        return Environment.authoring;
+        ContextType context = ContextType.development;
+
+        String contextValue = System.getProperty("SOLVER_CONTEXT", context.name());
+        try {
+            context = ContextType.valueOf(contextValue.toLowerCase().trim());
+        } catch(IllegalArgumentException e) {
+            LOG.error("Ignoring invalid SOLVER_CONTEXT value of " + contextValue + " using context " + context.name(), e);
+        }
+
+        return context;
     }
 
     public static class ConfigurationException extends Exception {
diff --git a/src/main/java/com/katacoda/solver/models/Hints.java b/src/main/java/com/katacoda/solver/models/Hints.java
index a9e045a..7e026d6 100644
--- a/src/main/java/com/katacoda/solver/models/Hints.java
+++ b/src/main/java/com/katacoda/solver/models/Hints.java
@@ -59,7 +59,7 @@ public String getHint(int task, int hint) {
     }
 
     private InputStream getSource() throws FileNotFoundException {
-        switch (Configuration.getEnvironment()) {
+        switch (Configuration.getContextType()) {
             case development:
                 return getClass().getClassLoader().getResourceAsStream(HINTS_MARKDOWN);
             case authoring:
diff --git a/src/main/java/com/katacoda/solver/models/Solutions.java b/src/main/java/com/katacoda/solver/models/Solutions.java
index fdc3a6c..f3f972a 100644
--- a/src/main/java/com/katacoda/solver/models/Solutions.java
+++ b/src/main/java/com/katacoda/solver/models/Solutions.java
@@ -42,7 +42,7 @@ public int executeShellFunction(String... functionAndParams) throws IOException
 
     private File getFunctionSourcingScript() {
 
-        if (!SOURCER.exists() || Configuration.getEnvironment() == Configuration.Environment.development) {
+        if (!SOURCER.exists() || Configuration.getContextType() == Configuration.ContextType.development) {
             try (PrintWriter writer = new PrintWriter(new OutputStreamWriter(new FileOutputStream(SOURCER)))) {
                 writer.println("#!/bin/bash");
                 writer.println("# Inserted functions");
@@ -151,7 +151,7 @@ public String getSourceAsString() {
     }
 
     private InputStream getSource() throws FileNotFoundException {
-        switch (Configuration.getEnvironment()) {
+        switch (Configuration.getContextType()) {
             case development:
                 return Thread.currentThread().getContextClassLoader().getResourceAsStream(SOLUTIONS_SCRIPT);
             case authoring:
diff --git a/src/main/java/com/katacoda/solver/models/Verifications.java b/src/main/java/com/katacoda/solver/models/Verifications.java
index 83c5419..8e78450 100644
--- a/src/main/java/com/katacoda/solver/models/Verifications.java
+++ b/src/main/java/com/katacoda/solver/models/Verifications.java
@@ -50,7 +50,7 @@ public int executeShellFunction(String... functionAndParams) throws IOException
 
     private File getFunctionSourcingScript() {
 
-        if (!SOURCER.exists() || Configuration.getEnvironment() == Configuration.Environment.development) {
+        if (!SOURCER.exists() || Configuration.getContextType() == Configuration.ContextType.development) {
             try (PrintWriter writer = new PrintWriter(new OutputStreamWriter(new FileOutputStream(SOURCER)))) {
                 writer.println("#!/bin/bash");
                 writer.println("# Inserted functions");
@@ -116,7 +116,7 @@ public String getSourceAsString() {
 
     
     private InputStream getSource() throws FileNotFoundException {
-        switch (Configuration.getEnvironment()) {
+        switch (Configuration.getContextType()) {
             case development:
                 return Thread.currentThread().getContextClassLoader().getResourceAsStream(VERIFICATIONS_SCRIPT);
             case authoring:
diff --git a/src/main/java/com/katacoda/solver/subcommands/SubcommandAll.java b/src/main/java/com/katacoda/solver/subcommands/SubcommandAll.java
index 09e90eb..f0ba081 100644
--- a/src/main/java/com/katacoda/solver/subcommands/SubcommandAll.java
+++ b/src/main/java/com/katacoda/solver/subcommands/SubcommandAll.java
@@ -9,7 +9,7 @@
 import java.io.PrintWriter;
 import java.util.concurrent.Callable;
 
-@Command(name = "all", description = "Solve all remaining tasks")
+@Command(name = "all", description = "Solve all remaining tasks.")
 public class SubcommandAll implements Callable<Integer> {
 
     @Spec CommandSpec spec;
@@ -17,7 +17,7 @@ public class SubcommandAll implements Callable<Integer> {
     @Override
     public Integer call() {
 
-        if (Configuration.getEnvironment() == Configuration.Environment.authoring) {
+        if (Configuration.getContextType() == Configuration.ContextType.authoring) {
             out().println("Command only valid in running challenge.");
             return -1;
         }
diff --git a/src/main/java/com/katacoda/solver/subcommands/SubcommandCheck.java b/src/main/java/com/katacoda/solver/subcommands/SubcommandCheck.java
index c9ce1bb..50d8be4 100644
--- a/src/main/java/com/katacoda/solver/subcommands/SubcommandCheck.java
+++ b/src/main/java/com/katacoda/solver/subcommands/SubcommandCheck.java
@@ -10,7 +10,7 @@
 import java.io.PrintWriter;
 import java.util.concurrent.Callable;
 
-@Command(name = "check", commandListHeading = "Authoring", headerHeading = "XXXUsage:%n%n", description = "Determine the required artifacts for the challenge are present and correct. Checks in authoring or challenge environments.")
+@Command(name = "check", commandListHeading = "Authoring", headerHeading = "XXXUsage:%n%n", description = "Determine required artifacts for challenge are present and correct in either authoring or challenge contexts.")
 public class SubcommandCheck implements Callable<Integer> {
 
     @Spec
@@ -43,7 +43,7 @@ public Integer call() {
 
         out().println(Status.Warning.getStatus("Checklist details are evolving. See roadmap."));
 
-        switch (Configuration.getEnvironment()) {
+        switch (Configuration.getContextType()) {
             case development:
                 out().println(Status.Warning.getStatus("Checklist is not for the solver development environment."));
                 break;
diff --git a/src/main/java/com/katacoda/solver/subcommands/SubcommandCreate.java b/src/main/java/com/katacoda/solver/subcommands/SubcommandCreate.java
index aa568ec..48d8bbe 100644
--- a/src/main/java/com/katacoda/solver/subcommands/SubcommandCreate.java
+++ b/src/main/java/com/katacoda/solver/subcommands/SubcommandCreate.java
@@ -22,7 +22,7 @@
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipInputStream;
 
-@Command(name = "create", commandListHeading = "Authoring", description = "Create any missing files that are needed by Solver. Will not overwrite. Creates only when in authoring environment.")
+@Command(name = "create", commandListHeading = "Authoring", description = "Create a Challenge project from the given archetype when in authoring context")
 public class SubcommandCreate implements Callable<Integer> {
 
     private static final Logger LOG = Logger.getLogger(Configuration.class);
@@ -54,7 +54,7 @@ private enum Archetypes {basic, linux, kubernetes}
     @Override
     public Integer call() {
 
-        if (Configuration.getEnvironment() == Configuration.Environment.challenge) {
+        if (Configuration.getContextType() == Configuration.ContextType.challenge) {
             out("Command only valid during challenge authoring.");
             return 1;
         }
diff --git a/src/main/java/com/katacoda/solver/subcommands/SubcommandHint.java b/src/main/java/com/katacoda/solver/subcommands/SubcommandHint.java
index b909596..2631cf7 100644
--- a/src/main/java/com/katacoda/solver/subcommands/SubcommandHint.java
+++ b/src/main/java/com/katacoda/solver/subcommands/SubcommandHint.java
@@ -14,7 +14,7 @@
 import java.io.PrintWriter;
 import java.util.concurrent.Callable;
 
-@Command(name = "hint", description = "Peak at hint ID for the task number. Omitting # assumes current task")
+@Command(name = "hint", description = "Get hint give a task number and hint number.")
 public class SubcommandHint implements Callable<Integer> {
     private static final Logger LOG = Logger.getLogger(SubcommandHint.class);
 
diff --git a/src/main/java/com/katacoda/solver/subcommands/SubcommandNext.java b/src/main/java/com/katacoda/solver/subcommands/SubcommandNext.java
index db3c5fb..27a50df 100644
--- a/src/main/java/com/katacoda/solver/subcommands/SubcommandNext.java
+++ b/src/main/java/com/katacoda/solver/subcommands/SubcommandNext.java
@@ -9,14 +9,14 @@
 import java.io.PrintWriter;
 import java.util.concurrent.Callable;
 
-@Command(name = "next", description = "Solve current task and on success advance current task number")
+@Command(name = "next", description = "Solve current task and on success advance current task number.")
 public class SubcommandNext implements Callable<Integer> {
     @Spec CommandSpec spec;
 
     @Override
     public Integer call() {
 
-        if (Configuration.getEnvironment() == Configuration.Environment.authoring) {
+        if (Configuration.getContextType() == Configuration.ContextType.authoring) {
             out().println("Command only valid in running challenge.");
             return -1;
         }
diff --git a/src/main/java/com/katacoda/solver/subcommands/SubcommandReset.java b/src/main/java/com/katacoda/solver/subcommands/SubcommandReset.java
index eb1173f..ae4d3cd 100644
--- a/src/main/java/com/katacoda/solver/subcommands/SubcommandReset.java
+++ b/src/main/java/com/katacoda/solver/subcommands/SubcommandReset.java
@@ -8,13 +8,13 @@
 import java.io.PrintWriter;
 import java.util.concurrent.Callable;
 
-@Command(name = "reset", description = "Clear task tracker so next task is assumed to be 1")
+@Command(name = "reset", description = "Clear task tracker so next task is returned back to 1.")
 public class SubcommandReset implements Callable<Integer> {
     @Spec CommandSpec spec;
 
     @Override
     public Integer call() {
-        if (Configuration.getEnvironment() == Configuration.Environment.authoring) {
+        if (Configuration.getContextType() == Configuration.ContextType.authoring) {
             out().println("Command only valid in running challenge.");
             return -1;
         }
diff --git a/src/main/java/com/katacoda/solver/subcommands/SubcommandSolutions.java b/src/main/java/com/katacoda/solver/subcommands/SubcommandSolutions.java
index 3bdaa7d..3b2f092 100644
--- a/src/main/java/com/katacoda/solver/subcommands/SubcommandSolutions.java
+++ b/src/main/java/com/katacoda/solver/subcommands/SubcommandSolutions.java
@@ -82,7 +82,7 @@ private int doSolutions() throws SolutionsException {
         LOG.info("encrypt: " + exclusive.encrypt + ", decrypt key: " + exclusive.key);
 
         if (exclusive.encrypt) {
-            if (Configuration.getEnvironment() == Configuration.Environment.challenge) {
+            if (Configuration.getContextType() == Configuration.ContextType.challenge) {
                 throw new SolutionsException("The solutions.sh file cannot be encrypted within a running challenge.");
             }
             encrypt();
@@ -164,7 +164,7 @@ private void checkSolutionsEncInIndexCopiedAssets() throws SolutionsException {
     }
 
     private Path encryptLocation() {
-        switch (Configuration.getEnvironment()) {
+        switch (Configuration.getContextType()) {
             case development:
                 return Path.of(System.getProperty("java.io.tmpdir"), SOLUTIONS_SCRIPT_ENC);
             case authoring:
@@ -177,7 +177,7 @@ private Path encryptLocation() {
     }
 
     private Path decryptLocation() {
-        switch (Configuration.getEnvironment()) {
+        switch (Configuration.getContextType()) {
             case development:
                 return Path.of(System.getProperty("java.io.tmpdir"), SOLUTIONS_SCRIPT);
             case authoring:
@@ -190,7 +190,7 @@ private Path decryptLocation() {
     }
 
     private InputStream encryptSource() throws SolutionsException {
-        if (Configuration.getEnvironment() == Configuration.Environment.development) {
+        if (Configuration.getContextType() == Configuration.ContextType.development) {
             return getClass().getClassLoader().getResourceAsStream(SOLUTIONS_SCRIPT);
         }
 
@@ -227,7 +227,7 @@ private OutputStream decryptTarget() throws SolutionsException {
     }
 
     private InputStream getIndex() throws SolutionsException {
-        switch (Configuration.getEnvironment()) {
+        switch (Configuration.getContextType()) {
             case development:
                 return getClass().getClassLoader().getResourceAsStream(INDEX_NAME);
             case authoring:
diff --git a/src/main/java/com/katacoda/solver/subcommands/SubcommandStatus.java b/src/main/java/com/katacoda/solver/subcommands/SubcommandStatus.java
index 6696bfc..3dadd99 100644
--- a/src/main/java/com/katacoda/solver/subcommands/SubcommandStatus.java
+++ b/src/main/java/com/katacoda/solver/subcommands/SubcommandStatus.java
@@ -18,7 +18,7 @@ public class SubcommandStatus implements Callable<Integer> {
 
     @Override
     public Integer call() {
-        if (Configuration.getEnvironment() == Configuration.Environment.authoring) {
+        if (Configuration.getContextType() == Configuration.ContextType.authoring) {
             out().println("Command only valid in running challenge.");
             return -1;
         }
diff --git a/src/main/java/com/katacoda/solver/subcommands/SubcommandUntil.java b/src/main/java/com/katacoda/solver/subcommands/SubcommandUntil.java
index 7928986..50b6708 100644
--- a/src/main/java/com/katacoda/solver/subcommands/SubcommandUntil.java
+++ b/src/main/java/com/katacoda/solver/subcommands/SubcommandUntil.java
@@ -21,7 +21,7 @@ public class SubcommandUntil implements Callable<Integer> {
     @Override
     public Integer call() {
 
-        if (Configuration.getEnvironment() == Configuration.Environment.authoring) {
+        if (Configuration.getContextType() == Configuration.ContextType.authoring) {
             out().println("Command only valid in running challenge.");
             return -1;
         }
diff --git a/src/main/java/com/katacoda/solver/subcommands/SubcommandVerify.java b/src/main/java/com/katacoda/solver/subcommands/SubcommandVerify.java
index ffcaa5e..55a11c6 100644
--- a/src/main/java/com/katacoda/solver/subcommands/SubcommandVerify.java
+++ b/src/main/java/com/katacoda/solver/subcommands/SubcommandVerify.java
@@ -13,7 +13,7 @@
 
 import static picocli.CommandLine.Option;
 
-@Command(name = "verify", description = "Verify task number is complete")
+@Command(name = "verify", description = "Verify task number is complete.")
 public class SubcommandVerify implements Callable<Integer> {
 
     @Spec CommandSpec spec;
@@ -26,7 +26,7 @@ public class SubcommandVerify implements Callable<Integer> {
 
     @Override
     public Integer call() {
-        if (Configuration.getEnvironment() == Configuration.Environment.authoring) {
+        if (Configuration.getContextType() == Configuration.ContextType.authoring) {
             out().println("Command only valid in running challenge.");
             return -1;
         }