cic-tools 0.0.1.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b5f173d9c696478abbf51210e28288c9286dd120a7d80ca923fa814e6234ed0
+  data.tar.gz: bdf3a39d361e329c2dab6c9e02747c0073c7953908d2a87ab0df276cd3e5825f
+SHA512:
+  metadata.gz: 24d28cbfbc3a09719556f5172f683aaee459f1a5140fa60a8432e9e52425759996dad984c9374fd9bd39baf8ebf279350c82e7ee6128529760815684d4daf283
+  data.tar.gz: 71a8deabb640f6de58aefa3f653aa3dea6b3a1002210d3a16ad456f3470acdf2c8752bce15cfe0c26f098ab30a0bdce8d32167f2a7009a6d144a9413bfc7cb62

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/bin/cic

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/commands/cic'
+
+Commands::CIC::Command.start(ARGV)

data/bin/exercise

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require_relative '../lib/commands/exercise/command'
+Exercise::Command.start(ARGV)

data/lib/commands.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift(__dir__)
+require 'commands/cic'
+require 'commands/exercise/command'

data/lib/commands/cic.rb

@@ -0,0 +1,2 @@
+require_relative 'cic/helpers'
+require_relative 'cic/command'

data/lib/commands/cic/command.rb

@@ -0,0 +1,90 @@
+require 'thor'
+require 'open3'
+require_relative '../../utils/commandline'
+require_relative '../../utils/docker'
+require_relative '../track'
+
+module Commands
+  module CIC
+    class Command < Thor
+      CONTAINER_NOT_RUNNING_MSG = 'Container is not running'.freeze
+      CONTAINER_STOPPED_MSG = 'Container stopped'.freeze
+
+      class ContainerAlreadyRunningError < StandardError
+      end
+
+      class CICDirectoryMissing < StandardError
+      end
+
+      desc 'track', 'thing'
+      subcommand 'track', Track::Command
+
+      desc 'connect [CONTAINER_NAME]', 'log in to a container and see what happened'
+      option :command, desc: 'send a command to the container instead of logging in', required: false, default: nil
+      def connect(container_name)
+        command = "-it #{container_id(container_name)} "
+        command << (options[:command] || 'bash -l')
+        docker_exec(command)
+      end
+
+      desc 'down', 'Bring down environment supporting current exercise'
+
+      def down
+        in_cic_directory do
+          execute "#{courseware_environment} docker-compose down",
+                  pass_message: "Environment cic'd down :)",
+                  fail_message: 'Failed to cic down the environment see above output for details'
+        end
+      end
+
+      desc 'start IMAGE_TAG', 'log in to a container and see what happened'
+      option :map_port, desc: 'map hostport to container port'
+
+      desc 'up', 'Bring up environment to support the current exercise'
+
+      def up
+        in_cic_directory do
+          commands = ["#{courseware_environment} docker-compose up -d --remove-orphans"]
+
+          before_script = 'before'
+          commands << "./#{before_script}" if File.exist?(before_script)
+
+          after_script = 'after'
+          commands << "./#{after_script}" if File.exist?(after_script)
+
+          execute(*commands,
+                  pass_message: "Environment cic'd up :)",
+                  fail_message: 'Failed to cic up the environment see above output for details')
+        end
+      end
+
+      no_commands do
+        include Commandline::Output
+        include Docker
+        include Helpers
+
+        private
+
+        def in_cic_directory
+          cic_directory = '.cic'
+          raise CICDirectoryMissing unless File.exist?(cic_directory)
+
+          Dir.chdir(cic_directory) do
+            yield
+          end
+        end
+
+        def normalise(string)
+          string.gsub(%r{[:/]}, '-')
+        end
+
+        def start_help_msg(container_name)
+          <<-MESSAGE
+          Connect with: cic connect #{container_name}
+          Stop with   : cic stop #{container_name}
+          MESSAGE
+        end
+      end
+    end
+  end
+end

data/lib/commands/cic/helpers.rb

@@ -0,0 +1,21 @@
+module Commands
+  module CIC
+    module Helpers
+      def courseware_environment
+        "CIC_COURSEWARE_VERSION=#{courseware_version} CIC_COURSEWARE_IMAGE=#{courseware_image} CIC_PWD=#{cic_pwd}"
+      end
+
+      def courseware_image
+        ENV['CIC_COURSEWARE_IMAGE']
+      end
+
+      def courseware_version
+        ENV['CIC_COURSEWARE_VERSION']
+      end
+
+      def cic_pwd
+        ENV['CIC_PWD']
+      end
+    end
+  end
+end

data/lib/commands/exercise/command.rb

@@ -0,0 +1,214 @@
+require 'erb'
+require 'thor'
+require 'rake'
+require 'json'
+
+require_relative 'instructions'
+require_relative 'render_methods'
+
+module Exercise
+  class CourseContentRenderingError < StandardError
+    def initialize(files)
+      error = <<~ERROR
+        Unable to render:
+        - #{files.collect { |file| File.expand_path(file) }.join("\n- ")}"
+      ERROR
+
+      super error
+    end
+
+    def ==(other)
+      other.is_a?(CourseContentRenderingError) && message == other.message
+    end
+  end
+
+  class Path
+    attr_reader :full
+
+    def initialize(full_path, project_root)
+      @full = full_path
+      @project_root = project_root
+    end
+
+    def relative
+      ".#{File.expand_path(full).gsub(File.expand_path(project_root), '')}"
+    end
+
+    private
+
+    attr_reader :project_root
+  end
+
+  class Template
+    attr_reader :dir, :path, :full_path
+
+    def initialize(path, project_root_dir)
+      @full_path = path
+      @dir = parent_directory(path)
+      @path = relative_path(path, dir)
+      @relative_directory = relative_path(dir, project_root_dir)
+    end
+
+    def rendered_file_path
+      full_path.gsub(%r{.templates/.*?erb}, filename).gsub('.erb', '')
+    end
+
+    def filename
+      File.basename(path)
+    end
+
+    def relative_path(full_path, root)
+      ".#{File.expand_path(full_path).gsub(File.expand_path(root), '')}"
+    end
+
+    private
+
+    def parent_directory(dir)
+      File.expand_path("#{File.dirname(dir)}/..").to_s
+    end
+  end
+
+  class CommandError < StandardError
+  end
+
+  module Helpers
+    include RenderMethods
+
+    def all_files_in(name)
+      Dir.glob("#{name}/**/*", File::FNM_DOTMATCH).find_all { |file| !%w[. ..].include?(File.basename(file)) }
+    end
+
+    def all_updated(paths, project_root_dir)
+      paths.find_all { |path| template_updated?(path, project_root_dir) }.collect do |template|
+        Template.new(template, project_root_dir)
+      end
+    end
+
+    def exercise_structure
+      @exercise_structure ||= YAML.safe_load(File.read(ENV['SCAFFOLD_STRUCTURE']))
+    end
+
+    def exercise_directories(path)
+      Dir["#{path}/**/.templates"]
+    end
+
+    def print_rendering_banner(template_path)
+      template_message = "# Generating template: #{template_path} in path: #{ENV['exercise_path']} #"
+      top_and_tail = ''.rjust(template_message.length, '#')
+      say "#{top_and_tail}\n#{template_message}\n#{top_and_tail}"
+    end
+
+    def process_template(original_dir, template)
+      template_dir = template.dir
+      Dir.chdir template_dir
+      ENV['exercise_path'] = template_dir.gsub(original_dir, '')
+      ENV['CIC_PWD'] = "#{ENV['CIC_PWD']}/#{template.relative_path(template_dir, original_dir)}"
+      print_rendering_banner(template.path)
+      !render_exercise(template.path, digest_component: options[:digest_component])
+    ensure
+      ENV['CIC_PWD'] = original_dir
+      Dir.chdir original_dir
+    end
+
+    def quiet?
+      options[:verbose] == false
+    end
+
+    def scaffold_path
+      @scaffold_path ||= ENV['SCAFFOLD_PATH']
+    end
+
+    def register_environment(environment_variables_string)
+      environment_variables = environment_variables_string.to_s.scan(%r{([\w+.]+)\s*=\s*([\w+./-]+)?}).to_h
+      environment_variables.each { |key, value| ENV[key] = value }
+    end
+
+    def templates(path)
+      exercise_directories(path).collect do |templates_dir|
+        Dir["#{File.expand_path(templates_dir)}/*.md.erb"]
+      end.flatten
+    end
+
+    def template_updated?(template, project_root_dir)
+      template = template.is_a?(String) ? Template.new(template, project_root_dir) : template
+
+      return true unless File.exist?(template.rendered_file_path)
+
+      digest = digest(path: template.dir,
+                      digest_component: options[:digest_component],
+                      excludes: excluded_files(template.full_path))
+
+      !File.read(template.rendered_file_path).include?(digest)
+    end
+  end
+
+  class Command < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'requiring_update', 'generate checksum'
+    option :digest_component,
+           type: :string,
+           required: false,
+           default: '',
+           desc: 'value to be considered when generating digest'
+
+    def requiring_update(path = '.')
+      directories = if File.directory?(path)
+                      templates(path)
+                    else
+                      [template]
+                    end
+
+      results = directories.find_all do |temp|
+        template_updated?(temp, Dir.pwd)
+      end.flatten
+
+      say results.to_json
+    end
+
+    desc 'generate', 'render templates'
+    option :verbose, type: :boolean, default: false
+    option :environment_variables, type: :string, required: false
+    option :digest_component,
+           type: :string,
+           required: false,
+           desc: 'value to be considered when generating digest',
+           default: ''
+
+    def generate(path = '.')
+      register_environment(options[:environment_variables])
+
+      templates = File.directory?(path) ? templates(path) : [path]
+
+      original_dir = Dir.pwd
+      failures = all_updated(templates, original_dir).find_all do |template|
+        process_template(original_dir, template)
+      end
+
+      raise CourseContentRenderingError, failures.collect(&:path) unless failures.empty?
+    end
+
+    desc 'create <NAME>', 'create a new exercise'
+
+    def create(name)
+      say "Creating new exercise: #{name}"
+      FileUtils.mkdir_p(name)
+
+      exercise_structure['directories'].each do |directory|
+        FileUtils.mkdir_p("#{name}/#{directory}")
+      end
+
+      FileUtils.cp_r("#{scaffold_path}/.", name)
+
+      all_files_in(name).each { |path| say "Created: #{path}" }
+
+      say ok 'Complete'
+    end
+
+    no_commands do
+      include Helpers
+    end
+  end
+end