Merge pull request #5 from juan-ayala/feature/aem-sdk-path-updates

Create start-aem script

src/aem-sdk/NOTES.md

@@ -20,15 +20,14 @@
 ## Step 3: Visual Studio Code
 * Install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). And open the project folder.
 * VSCode will detect `.devcontainer/devcontainer.json`. And prompt you to reopen the project in a devcontainer.
-* After the container gets created, the feature will run the setup scripts. They will create the folder structure for an author and publish service. And unpack the dispatcher tools.
 
 ## Run AEM Services
 In VSCode, open the terminal window. This is a terminal inside the docker container. You can run any command as needed, including Maven and Node.
 
-Additionally, the feature will have added some helpful aliases
-* `start-author`
-* `start-publish`
-* `start-dispatcher`
+There will be a script named `start-aem`. Use this to start the author, publish or dispatcher.
+* Start author: `start-aem author`
+* Start publish: `start-aem publish`
+* Start dispatcher: `start-aem dispatcher`
 
 The feature also sets up volume mounts for the author and publish services. This is where the services will persist the repository. So that if the container gets deleted and/or rebuilt, the repository will persist.
 

src/aem-sdk/scripts/setup-dispatcher.sh → src/aem-sdk/bin/aem-sdk-setup-dispatcher.sh

@@ -17,9 +17,8 @@ sudo bash -c "${installscript}"
 sudo rm ${installscript}
 cd ${cwd}
 
-# rename directory and add bin to PATH
+# rename directory
 sudo find ${AEM_SDK_FEATURE_DIR}/dispatcher-sdk-* -maxdepth 0 -type d -execdir mv {} dispatcher \;
-add_line_to_shell_rc "export PATH=${PATH}:${AEM_SDK_FEATURE_DIR}/dispatcher/bin"
 
 # alias to start dispatcher
-add_line_to_shell_rc "alias start-dispatcher='cd dispatcher && ${AEM_SDK_FEATURE_DIR}/dispatcher/bin/docker_run.sh src host.docker.internal:${AEM_SDK_PUBLISH_PORT} ${AEM_SDK_DISPATCHER_PORT}'"
+add_line_to_shell_rc "alias start-dispatcher='docker_run.sh src host.docker.internal:${AEM_SDK_PUBLISH_PORT} ${AEM_SDK_DISPATCHER_PORT}'"

src/aem-sdk/bin/start-aem

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+
+usage() {
+    cat <<EOM
+Usage: $(basename $0) <service> 
+where 
+  <service> is 'dispatcher' or 'author' or 'publish'
+EOM
+    exit 1
+}
+
+[ "${1}" = 'dispatcher' ] && service="${1}"
+[ "${1}" = 'author' ] && service="${1}"
+[ "${1}" = 'publish' ] && service="${1}"
+[ -z "${service}" ] && usage
+
+source "$(dirname $0)/_globals.sh"
+
+if [[ "${service}" == "dispatcher" ]]; then
+
+    toolsdir="${AEM_SDK_FEATURE_DIR}/dispatcher"
+    # setup if dispatcher directory is missing
+    if [[ ! -d ${toolsdir} ]]; then
+        $(dirname $0)/aem-sdk-setup-dispatcher.sh
+    fi
+
+elif [[ "${service}" == "author" || "${service}" == "publish" ]]; then
+
+    jar="${AEM_SDK_FEATURE_DIR}/${service}/$(get_runmode_jar ${service})"
+    # setup aem if jar file is missing
+    if [[ ! -f ${jar} ]]; then
+        $(dirname $0)/aem-sdk-setup-service.sh ${service}
+    fi
+fi
+
+bash -ci "start-${service}"

src/aem-sdk/devcontainer-feature.json

@@ -1,6 +1,6 @@
 {
     "id": "aem-sdk",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "name": "Adobe Experience Manager SDK",
     "description": "Setup author and publish services. And the dispatcher tools. Requires the AEM as a Cloud Service SDK.",
     "options": {
@@ -31,7 +31,8 @@
         }
     },
     "containerEnv": {
-        "AEM_SDK_FEATURE_DIR": "/aem-sdk"
+        "AEM_SDK_FEATURE_DIR": "/aem-sdk",
+        "PATH": "/aem-sdk/bin:/aem-sdk/dispatcher/bin:${PATH}"
     },
     "mounts": [
         {
@@ -45,19 +46,6 @@
             "type": "volume"
         }
     ],
-    "onCreateCommand": {
-        "publish-instance": [
-            "/aem-sdk/scripts/setup-service.sh",
-            "publish"
-        ],
-        "author-instance": [
-            "/aem-sdk/scripts/setup-service.sh",
-            "author"
-        ],
-        "dispatcher": [
-            "/aem-sdk/scripts/setup-dispatcher.sh"
-        ]
-    },
     "dependsOn": {
         "ghcr.io/devcontainers/features/docker-in-docker:2": {}
     },

src/aem-sdk/install.sh

@@ -13,5 +13,4 @@ echo "AEM_SDK_DISPATCHER_PORT=\"${DISPATCHERPORT:-'8080'}\"" >> ${propertiesFile
 source ${propertiesFile}
 
 # copy custom scripts
-cp -r "$(dirname $0)/scripts" ${AEM_SDK_FEATURE_DIR}
-#find "${AEM_SDK_FEATURE_DIR}/scripts" -name "*.sh" -exec chmod +x {} \;
+cp -r "$(dirname $0)/bin" ${AEM_SDK_FEATURE_DIR}

test/aem-sdk/defaults-with-sdk.sh

@@ -16,26 +16,15 @@ check "publish port default" \
     [ "${AEM_SDK_PUBLISH_PORT}" = "4503" ]
 check "dispatcher port default" \
     [ "${AEM_SDK_DISPATCHER_PORT}" = "8080" ]
-# Check setup scripts installed
-check "_globals is +x" \
-    stat -c '%A' ${AEM_SDK_FEATURE_DIR}/scripts/_globals.sh | grep 'x.*x.*x'
-check "setup-dispatcher is +x" \
-    stat -c '%A' ${AEM_SDK_FEATURE_DIR}/scripts/setup-dispatcher.sh | grep 'x.*x.*x'
-check "setup-service is +x" \
-    stat -c '%A' ${AEM_SDK_FEATURE_DIR}/scripts/setup-service.sh | grep 'x.*x.*x'
-# Check instance jars and dispatcher run script installed
-check "author jar installed" \
-    [ -f "${AEM_SDK_FEATURE_DIR}/author/aem-author-p${AEM_SDK_AUTHOR_PORT}.jar" ]
-check "publish jar installed" \
-    [ -f "${AEM_SDK_FEATURE_DIR}/publish/aem-publish-p${AEM_SDK_PUBLISH_PORT}.jar" ]
-check "dispatcher tools installed" \
-    [ -d "${AEM_SDK_FEATURE_DIR}/dispatcher/bin" ]
-# Check aliases added can execute the mock files from the mock sdk
-check "can run start-author mock" \
-    bash -ci "start-author | grep 'hello, world'"
-check "can run start-publish mock" \
-    bash -ci "start-author | grep 'hello, world'"
-check "can run start-dispatcher mock" \
-    bash -ci "start-author | grep 'hello, world'"
+# Check start-aem in PATH is executable
+check "start-aem is +x" \
+    stat -c '%A' $(which start-aem) | grep 'x.*x.*x'
+# Check that author/publish/dispatcher installs and starts
+check "can install & run author" \
+    bash -ci "start-aem author | grep 'hello, world'"
+check "can install & run publish" \
+    bash -ci "start-aem publish | grep 'hello, world'"
+check "can install & run dispatcher" \
+    bash -ci "start-aem dispatcher | grep 'All your base are belong to us'"
 
 reportResults

test/aem-sdk/options-with-sdk.sh

@@ -16,26 +16,15 @@ check "publish port default" \
     [ "${AEM_SDK_PUBLISH_PORT}" = "3002" ]
 check "dispatcher port default" \
     [ "${AEM_SDK_DISPATCHER_PORT}" = "8090" ]
-# Check setup scripts installed
-check "_globals is +x" \
-    stat -c '%A' ${AEM_SDK_FEATURE_DIR}/scripts/_globals.sh | grep 'x.*x.*x'
-check "setup-dispatcher is +x" \
-    stat -c '%A' ${AEM_SDK_FEATURE_DIR}/scripts/setup-dispatcher.sh | grep 'x.*x.*x'
-check "setup-service is +x" \
-    stat -c '%A' ${AEM_SDK_FEATURE_DIR}/scripts/setup-service.sh | grep 'x.*x.*x'
-# Check instance jars and dispatcher run script installed
-check "author jar installed" \
-    [ -f "${AEM_SDK_FEATURE_DIR}/author/aem-author-p${AEM_SDK_AUTHOR_PORT}.jar" ]
-check "publish jar installed" \
-    [ -f "${AEM_SDK_FEATURE_DIR}/publish/aem-publish-p${AEM_SDK_PUBLISH_PORT}.jar" ]
-check "dispatcher tools installed" \
-    [ -d "${AEM_SDK_FEATURE_DIR}/dispatcher/bin" ]
-# Check aliases added can execute the mock files from the mock sdk
-check "can run start-author mock" \
-    bash -ci "start-author | grep 'hello, world'"
-check "can run start-publish mock" \
-    bash -ci "start-author | grep 'hello, world'"
-check "can run start-dispatcher mock" \
-    bash -ci "start-author | grep 'hello, world'"
+# Check start-aem in PATH is executable
+check "start-aem is +x" \
+    stat -c '%A' $(which start-aem) | grep 'x.*x.*x'
+# Check that author/publish/dispatcher installs and starts
+check "can install & run author" \
+    bash -ci "start-aem author | grep 'hello, world'"
+check "can install & run publish" \
+    bash -ci "start-aem publish | grep 'hello, world'"
+check "can install & run dispatcher" \
+    bash -ci "start-aem dispatcher | grep 'All your base are belong to us'"
 
 reportResults

test/aem-sdk/test.sh

@@ -28,13 +28,9 @@ check "publish port default" \
     [ "${AEM_SDK_PUBLISH_PORT}" = "4503" ]
 check "dispatcher port default" \
     [ "${AEM_SDK_DISPATCHER_PORT}" = "8080" ]
-# Check setup scripts installed
-check "_globals is +x" \
-    stat -c '%A' ${AEM_SDK_FEATURE_DIR}/scripts/_globals.sh | grep 'x.*x.*x'
-check "setup-dispatcher is +x" \
-    stat -c '%A' ${AEM_SDK_FEATURE_DIR}/scripts/setup-dispatcher.sh | grep 'x.*x.*x'
-check "setup-service is +x" \
-    stat -c '%A' ${AEM_SDK_FEATURE_DIR}/scripts/setup-service.sh | grep 'x.*x.*x'
+# Check start-aem in PATH is executable
+check "start-aem is +x" \
+    stat -c '%A' $(which start-aem) | grep 'x.*x.*x'
 # Check instance jars and dispatcher run script not installed
 check "no author jar" \
     [ ! -f "${AEM_SDK_FEATURE_DIR}/author/aem-author-p${AEM_SDK_AUTHOR_PORT}.jar" ]