(CDPE-6808) Remove references to docker in code

Just to make functions and variables clearer, remove all references to
docker.

Author: abottchen

spec/docker_spec.rb

@@ -37,16 +37,16 @@
   describe 'cd4pe_job_helper::get_runtime' do
     it 'Detects docker as the available runtime.' do
       test_container_image = 'puppetlabs/test:10.0.1'
-      job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, docker_image: test_container_image, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
+      job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, container_image: test_container_image, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
       expect(job_helper.get_runtime).to eq('docker')
     end
   end
 
-  describe 'cd4pe_job_helper::update_docker_image' do
+  describe 'cd4pe_job_helper::update_container_image' do
     let(:test_container_image) { 'puppetlabs/test:10.0.1' }
     it 'Generates a docker pull command.' do
-      job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, docker_image: test_container_image, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
-      docker_pull_command = job_helper.get_docker_pull_cmd
+      job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, container_image: test_container_image, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
+      docker_pull_command = job_helper.get_image_pull_cmd
       expect(docker_pull_command).to eq("docker pull #{test_container_image}")
     end
 
@@ -58,17 +58,17 @@
       let(:cert_b64) { Base64.encode64(cert_txt) }
 
       it 'Uses config when present for docker.' do
-        job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, docker_image: test_container_image, docker_pull_creds: creds_b64, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
+        job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, container_image: test_container_image, image_pull_creds: creds_b64, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
         config_json = File.join(@working_dir, '.docker', 'config.json')
         expect(File.exist?(config_json)).to be(true)
         expect(File.read(config_json)).to eq(creds_json)
 
-        docker_pull_command = job_helper.get_docker_pull_cmd
+        docker_pull_command = job_helper.get_image_pull_cmd
         expect(docker_pull_command).to eq("docker --config #{File.join(@working_dir, '.docker')} pull #{test_container_image}")
       end
 
       it 'Registers the CA cert when provided.' do
-        job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, docker_image: test_container_image, docker_pull_creds: creds_b64, base_64_ca_cert: cert_b64, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
+        job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, container_image: test_container_image, image_pull_creds: creds_b64, base_64_ca_cert: cert_b64, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
 
         cert_file = File.join(@certs_dir, hostname, 'ca.crt')
         expect(File.exist?(cert_file)).to be(true)
@@ -77,7 +77,7 @@
     end
   end
 
-  describe 'cd4pe_job_helper::get_docker_run_cmd' do
+  describe 'cd4pe_job_helper::get_container_run_cmd' do
     it 'Generates the correct docker run command.' do
       test_manifest_type = "AFTER_JOB_SUCCESS"
       test_container_image = 'puppetlabs/test:10.0.1'
@@ -87,9 +87,9 @@
       user_specified_container_run_args = [arg1, arg2, arg3]
       job_type = 'unix'
 
-      job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, docker_image: test_container_image, docker_run_args: user_specified_container_run_args, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
+      job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, container_image: test_container_image, container_run_args: user_specified_container_run_args, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
 
-      docker_run_command = job_helper.get_docker_run_cmd(test_manifest_type)
+      docker_run_command = job_helper.get_container_run_cmd(test_manifest_type)
       cmd_parts = docker_run_command.split(' ')
 
       expect(cmd_parts[0]).to eq('docker')

spec/podman_spec.rb

@@ -37,16 +37,16 @@
   describe 'cd4pe_job_helper::get_runtime' do
     it 'Detects podman as the available runtime.' do
       test_container_image = 'puppetlabs/test:10.0.1'
-      job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, docker_image: test_container_image, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
+      job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, container_image: test_container_image, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
       expect(job_helper.get_runtime).to eq('podman')
     end
   end
 
-  describe 'cd4pe_job_helper::update_docker_image' do
+  describe 'cd4pe_job_helper::update_container_image' do
     let(:test_container_image) { 'puppetlabs/test:10.0.1' }
     it 'Generates a podman pull command.' do
-      job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, docker_image: test_container_image, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
-      podman_pull_command = job_helper.get_docker_pull_cmd
+      job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, container_image: test_container_image, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
+      podman_pull_command = job_helper.get_image_pull_cmd
       expect(podman_pull_command).to eq("podman pull #{test_container_image}")
     end
 
@@ -58,17 +58,17 @@
       let(:cert_b64) { Base64.encode64(cert_txt) }
 
       it 'Uses config when present for podman.' do
-        job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, docker_image: test_container_image, docker_pull_creds: creds_b64, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
+        job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, container_image: test_container_image, image_pull_creds: creds_b64, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
         config_json = File.join(@working_dir, '.docker', 'config.json')
         expect(File.exist?(config_json)).to be(true)
         expect(File.read(config_json)).to eq(creds_json)
 
-        podman_pull_command = job_helper.get_docker_pull_cmd
+        podman_pull_command = job_helper.get_image_pull_cmd
         expect(podman_pull_command).to eq("podman --config #{File.join(@working_dir, '.docker')} pull #{test_container_image}")
       end
 
       it 'Registers the CA cert when provided.' do
-        job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, docker_image: test_container_image, docker_pull_creds: creds_b64, base_64_ca_cert: cert_b64, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
+        job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, container_image: test_container_image, image_pull_creds: creds_b64, base_64_ca_cert: cert_b64, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
 
         cert_file = File.join(@certs_dir, hostname, 'ca.crt')
         expect(File.exist?(cert_file)).to be(true)
@@ -77,7 +77,7 @@
     end
   end
 
-  describe 'cd4pe_job_helper::get_docker_run_cmd' do
+  describe 'cd4pe_job_helper::get_container_run_cmd' do
     it 'Generates the correct podman run command.' do
       test_manifest_type = "AFTER_JOB_SUCCESS"
       test_container_image = 'puppetlabs/test:10.0.1'
@@ -87,9 +87,9 @@
       user_specified_container_run_args = [arg1, arg2, arg3]
       job_type = 'unix'
 
-      job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, docker_image: test_container_image, docker_run_args: user_specified_container_run_args, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
+      job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, container_image: test_container_image, container_run_args: user_specified_container_run_args, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
 
-      podman_run_command = job_helper.get_docker_run_cmd(test_manifest_type)
+      podman_run_command = job_helper.get_container_run_cmd(test_manifest_type)
       cmd_parts = podman_run_command.split(' ')
 
       expect(cmd_parts[0]).to eq('podman')

spec/run_cd4pe_job_spec.rb

@@ -139,15 +139,15 @@
   end
 
   describe 'cd4pe_job_helper::initialize' do
-    it 'Passes the docker run args through without modifying the structure.' do
+    it 'Passes the container run args through without modifying the structure.' do
       arg1 = '--testarg=woot'
       arg2 = '--otherarg=hello'
       arg3 = '--whatever=isclever'
-      user_specified_docker_run_args = [arg1, arg2, arg3]
+      user_specified_container_run_args = [arg1, arg2, arg3]
 
-      job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, docker_run_args: user_specified_docker_run_args, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
+      job_helper = CD4PEJobRunner.new(windows_job: @windows_job, working_dir: @working_dir, container_run_args: user_specified_container_run_args, job_token: @job_token, web_ui_endpoint: @web_ui_endpoint, job_owner: @job_owner, job_instance_id: @job_instance_id, logger: @logger, secrets: @secrets)
 
-      expect(job_helper.docker_run_args).to eq("#{arg1} #{arg2} #{arg3}")
+      expect(job_helper.container_run_args).to eq("#{arg1} #{arg2} #{arg3}")
     end
 
     it 'Sets the HOME and REPO_DIR env vars' do

tasks/run_cd4pe_job.rb

@@ -196,7 +196,7 @@ def make_request(type, api_url, payload = '')
 
 class CD4PEJobRunner < Object
   # Class for downloading, running, and logging CD4PE jobs
-  attr_reader :docker_run_args
+  attr_reader :container_run_args
 
   MANIFEST_TYPE = {
     :JOB => "JOB",
@@ -206,12 +206,12 @@ class CD4PEJobRunner < Object
   DOCKER_CERTS = '/etc/docker/certs.d'
   PODMAN_CERTS = '/etc/containers/certs.d'
 
-  def initialize(working_dir:, job_token:, web_ui_endpoint:, job_owner:, job_instance_id:, logger:, windows_job: false, base_64_ca_cert: nil, docker_image: nil, docker_run_args: nil, docker_pull_creds: nil, secrets:)
+  def initialize(working_dir:, job_token:, web_ui_endpoint:, job_owner:, job_instance_id:, logger:, windows_job: false, base_64_ca_cert: nil, container_image: nil, container_run_args: nil, image_pull_creds: nil, secrets:)
     @logger = logger
     @image_repo = nil
-    @docker_image = docker_image
-    @docker_run_args = docker_run_args.nil? ? '' : docker_run_args.join(' ')
-    @docker_based_job = !blank?(docker_image)
+    @container_image = container_image
+    @container_run_args = container_run_args.nil? ? '' : container_run_args.join(' ')
+    @containerized_job = !blank?(container_image)
     @windows_job = windows_job
     @runtime = get_runtime
     @cert_dir = @runtime == 'podman' ? PODMAN_CERTS : DOCKER_CERTS
@@ -235,21 +235,21 @@ def initialize(working_dir:, job_token:, web_ui_endpoint:, job_owner:, job_insta
       end
     end
 
-    @docker_pull_config = nil
-    if (!docker_pull_creds.nil?)
-      creds = Base64.decode64(docker_pull_creds)
+    @image_pull_config = nil
+    if (!image_pull_creds.nil?)
+      creds = Base64.decode64(image_pull_creds)
       # podman-login manpage states it uses `.docker/config.json`, so this
       # applies to both runtimes
-      @docker_pull_config = File.join(@working_dir, ".docker")
-      make_dir(@docker_pull_config)
-      open(File.join(@docker_pull_config, "config.json"), "wb") do |file|
+      @image_pull_config = File.join(@working_dir, ".docker")
+      make_dir(@image_pull_config)
+      open(File.join(@image_pull_config, "config.json"), "wb") do |file|
         file.write(creds)
       end
 
-      # Ensure the ca_cert_file is added for each Docker registry we might use.
+      # Ensure the ca_cert_file is added for each registry we might use.
       if @ca_cert_file
-        docker_conf = JSON.parse(creds)
-        docker_conf['auths'].each do |host, _cred|
+        runtime_conf = JSON.parse(creds)
+        runtime_conf['auths'].each do |host, _cred|
           dir = File.join(@cert_dir, host)
           FileUtils.mkdir_p(dir)
           cert = File.join(dir, 'ca.crt')
@@ -388,9 +388,9 @@ def on_job_complete(result, next_manifest_type)
   def execute_manifest(manifest_type)
     @logger.log("Executing #{manifest_type} manifest.")
     result = {}
-    if (@docker_based_job)
-      @logger.log("Container image specified. Running #{manifest_type} manifest on container image: #{@docker_image}.")
-      result = run_with_docker(manifest_type)
+    if (@containerized_job)
+      @logger.log("Container image specified. Running #{manifest_type} manifest on container image: #{@container_image}.")
+      result = run_in_container(manifest_type)
     else
       @logger.log("No container image specified. Running #{manifest_type} manifest directly on machine.")
       result = run_with_system(manifest_type)
@@ -415,38 +415,38 @@ def run_with_system(manifest_type)
     run_system_cmd(cmd_to_execute)
   end
 
-  def get_docker_pull_cmd
-    image = @image_repo.nil? ? @docker_image : "#{@image_repo}/#{@docker_image}"
-    if @docker_pull_config.nil?
+  def get_image_pull_cmd
+    image = @image_repo.nil? ? @container_image : "#{@image_repo}/#{@container_image}"
+    if @image_pull_config.nil?
       "#{@runtime} pull #{image}"
     else
-      "#{@runtime} --config #{@docker_pull_config} pull #{image}"
+      "#{@runtime} --config #{@image_pull_config} pull #{image}"
     end
   end
 
-  def update_docker_image
-    if (@docker_based_job)
-      @logger.log("Updating container image: #{@docker_image}")
-      result = run_system_cmd(get_docker_pull_cmd)
+  def update_container_image
+    if (@containerized_job)
+      @logger.log("Updating container image: #{@container_image}")
+      result = run_system_cmd(get_image_pull_cmd)
       if (result[:exit_code] == 125)
         @logger.log("Failed to pull using given image name. Re-try directly from docker.io.")
         @image_repo = 'docker.io'
-        result = run_system_cmd(get_docker_pull_cmd)
+        result = run_system_cmd(get_image_pull_cmd)
       end
 
       @logger.log(result[:message])
     end
   end
 
-  def get_docker_run_cmd(manifest_type)
+  def get_container_run_cmd(manifest_type)
     suffix = @runtime == 'podman' ? ':z' : ''
     repo_volume_mount = "\"#{@local_repo_dir}:/repo#{suffix}\""
     scripts_volume_mount = "\"#{@local_jobs_dir}:/cd4pe_job#{suffix}\""
-    docker_bash_script = "\"/cd4pe_job/#{manifest_type}\""
-    "#{@runtime} run --rm #{@docker_run_args} #{get_docker_secrets_cmd} -v #{repo_volume_mount} -v #{scripts_volume_mount} #{@docker_image} #{docker_bash_script}"
+    container_bash_script = "\"/cd4pe_job/#{manifest_type}\""
+    "#{@runtime} run --rm #{@container_run_args} #{get_container_secrets_cmd} -v #{repo_volume_mount} -v #{scripts_volume_mount} #{@container_image} #{container_bash_script}"
   end
 
-  def get_docker_secrets_cmd
+  def get_container_secrets_cmd
     return "" if @secrets.nil?
 
     @secrets.keys.reduce("") do |memo, key|
@@ -455,7 +455,7 @@ def get_docker_secrets_cmd
   end
 
   def get_runtime
-    if !@docker_based_job
+    if !@containerized_job
       return nil
     end
 
@@ -482,9 +482,9 @@ def get_runtime
     end
   end
 
-  def run_with_docker(manifest_type)
-    docker_cmd = get_docker_run_cmd(manifest_type)
-    run_system_cmd(docker_cmd)
+  def run_in_container(manifest_type)
+    cmd = get_container_run_cmd(manifest_type)
+    run_system_cmd(cmd)
   end
 
   def run_system_cmd(cmd, log_output = true)
@@ -601,9 +601,9 @@ def blank?(str)
 
     params = JSON.parse(STDIN.read)
 
-    docker_image = params['docker_image']
-    docker_run_args = params["docker_run_args"]
-    docker_pull_creds = params['docker_pull_creds']
+    container_image = params['docker_image']
+    container_run_args = params["docker_run_args"]
+    image_pull_creds = params['docker_pull_creds']
     job_instance_id = params["job_instance_id"]
     web_ui_endpoint = params['cd4pe_web_ui_endpoint']
     job_token = params['cd4pe_token']
@@ -621,9 +621,9 @@ def blank?(str)
 
     job_runner = CD4PEJobRunner.new(
       working_dir: @working_dir,
-      docker_image: docker_image,
-      docker_run_args: docker_run_args,
-      docker_pull_creds: docker_pull_creds,
+      container_image: container_image,
+      container_run_args: container_run_args,
+      image_pull_creds: image_pull_creds,
       job_token: job_token,
       web_ui_endpoint: web_ui_endpoint,
       job_owner: job_owner,
@@ -633,7 +633,7 @@ def blank?(str)
       secrets: secrets,
       logger: @logger)
     job_runner.get_job_script_and_control_repo
-    job_runner.update_docker_image
+    job_runner.update_container_image
     output = job_runner.run_job
 
     output[:logs] = @logger.get_logs