Add instructions on how to run emasser in Docker

Author: georgedias

.dockerignore

@@ -1,11 +1,21 @@
 # git
-.git
 .gitignore
+Gemfile.lock
 CHANGELOG.md
 
+# VS Code
+.vscode/
+
+# doc
+doc/
+
 # ci
-.gitlab-ci.yml
+.github
+_config.yml
 
 # code
 spec
-.env
+
+#rubocop
+.rubocop.yml
+.rubocop_todo.yml

.gitignore

@@ -11,8 +11,9 @@
 
 **/*.un~
 
-emassing/test/test_example.zip
 .DS_Store
 .byebug_history
 .env
+key.pem
+client.pem
 *.gem

Dockerfile

@@ -1,25 +1,28 @@
 # Buld from ruby 2.7.5 image
-FROM ruby:2.7
+FROM ruby:2.7.5
 
-# LABEL name="emasser" \
-#       vendor="MTIRE" \
-#       version="${EMASSER_VERSION}" \
-#       release="1" \
-#       url="https://github.com/mitre/emasser" \
-#       description="Emasser is a command-line interface (CLI) that aims to automate routine business use-cases and provide utility surrounding the Enterprise Mission Assurance Support Service (eMASS) by leveraging its representational state transfer (REST) application programming interface (API)." \
-#       docs="https://mitre.github.io/emasser/" \
-#       run="docker run -d --name ${NAME} ${IMAGE} <args>"
+LABEL name="emasser" \
+      vendor="MITRE" \
+      version="${EMASSER_VERSION}" \
+      release="1" \
+      url="https://github.com/mitre/emasser" \
+      description="Emasser is a command-line interface (CLI) that aims to automate routine business use-cases and provide utility surrounding the Enterprise Mission Assurance Support Service (eMASS) by leveraging its representational state transfer (REST) application programming interface (API)." \
+      docs="https://mitre.github.io/emasser/" \
+      run="docker run -d --name ${NAME} ${IMAGE} <args>"
 
 # Set the base directory that will be used from now on
 WORKDIR /emasser
+VOLUME ["/emasser"]
 
 # Copy - source (.) destination (.)
 COPY . .
 
 # Don't install development or test dependencies
-# RUN bundle config set without 'development test'
+RUN bundle config set without 'development test'
 # Install dependency
+RUN gem install bundler -v '2.3.5'
 RUN bundle install
 
 ENTRYPOINT ["bundle", "exec", "exe/emasser"]
-CMD ["-hello"]
+
+CMD ["-h"]

Gemfile.lock

@@ -94,7 +94,7 @@ PLATFORMS
   x64-mingw32
 
 DEPENDENCIES
-  bundler (~> 2.3.4)
+  bundler (~> 2.3)
   bundler-audit (~> 0.7)
   byebug (~> 11.1.3)
   emass_client!
@@ -108,4 +108,4 @@ DEPENDENCIES
   yaml (~> 0.2.0)
 
 BUNDLED WITH
-   2.3.4
+   2.3.5

README.md

@@ -88,6 +88,49 @@ gem install emasser
 ```
 bundle exec exe/emasser [command]
 ```
+
+## Using Docker
+**Note:** Before building the container:
+  - Add a .env file containing the emasser required variables in the emasser source directory
+  - Place the certificates (key.pem and client.pem) used to access the eMASS URL in the emasser source directory as well
+
+### Build the Docker Container
+- Install and start Docker
+- Download emasser by running git clone https://github.com/mitre/emasser.git.
+- Navigate to the base folder where Dockerfile is located
+- Build the emasser container from a terminal window in the emasser source directory:
+  ``` 
+  docker build -t emasser .
+  ```
+- To see the build output use:
+  ```
+  docker build --no-cache --progress=plain -t emasser .
+  ```
+
+### Run the emasser Docker Container (--rm remove the container when exit)
+- To run the emasser container use:
+  ```
+  docker run --rm emasser
+  ```
+- To list all GET, POST, PUT, or DELETE commands use:
+  ```
+  docker run --rm emasser get help
+  ```
+  ```
+  docker run --rm emasser post help
+  ```
+  ```
+  docker run --rm emasser put help
+  ```
+  ```
+  docker run --rm emasser delete help
+  ```
+
+### Delete (remove) the Docker Container
+```
+  docker rmi -f emasser
+```
+
 ## Use
 
 **Requirement 1 & 2: Authentication and Authorization:**

emasser.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'thor', '~> 1.1.0'
   spec.add_runtime_dependency 'emass_client', '~> 1.0'
 
-  spec.add_development_dependency 'bundler', '~> 2.3.4'
+  spec.add_development_dependency 'bundler', '~> 2.3'
   spec.add_development_dependency 'bundler-audit', '~> 0.7'
   spec.add_development_dependency 'byebug', '~> 11.1.3'
   spec.add_development_dependency 'rspec', '~> 3.10.0'

lib/emasser/cli.rb

@@ -20,7 +20,8 @@ class CLI < Thor
       puts "emasser version: #{Emasser::VERSION}".green
       exit
     elsif ARGV[0].to_s.include? 'hello'
-      print "Hello #{ENV['USERNAME']} - enjoy using emasser!".cyan
+      user_name = ENV['USERNAME'] || 'rookie'
+      print "Hello #{user_name} - enjoy using emasser!".cyan
       exit
     end
 

lib/emasser/delete.rb

@@ -47,7 +47,7 @@ def self.exit_on_failure?
     end
 
     # Delete a POAM -----------------------------------------------------------
-    desc 'remove', 'Add one or many POA&M items in a system'
+    desc 'remove', 'Delete one or many POA&M items in a system'
     long_desc Help.text(:poam_del_mapper)
 
     # Required parameters/fields
@@ -110,7 +110,7 @@ def self.exit_on_failure?
       true
     end
 
-    desc 'remove', 'Remove one or many artifacts in a system'
+    desc 'remove', 'Delete one or many artifacts in a system'
     long_desc Help.text(:artifact_del_mapper)
 
     # Required parameters/fields