cyclid-core 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ae5e120afdbe2e4dc79c0106ab71fb478018cda
-  data.tar.gz: 703042beb35a28c7b69912f152c6c82c77690af1
+  metadata.gz: 99abddef50adfd4dbf2c21a3bcea9827c1584b18
+  data.tar.gz: 64fc2e722dc9e998cb56031e6b42b51ab200bcf0
 SHA512:
-  metadata.gz: 3e8dcb8faabca9d3398d15dd307c1772beebceb1a906d46001cc7b2d711c0b52f71557b6d4eb7f1f55ba0dc5d5d6caa319c109c1c8ba577066a875cc372c4ce1
-  data.tar.gz: f7baace3ced717be03739b144aec4fffdb3fa0b36abbf988c3e4d662588a00e8c08c484fb77bc71d74f7773efddfd13799621e74abe43419a7cdfdea64e2be11
+  metadata.gz: 2b83fc0f953bc10e807526f05d8a07c1beb2d7768ddaac2b085d1c5a71df71aaf66d428723a03c52dce410eb9fd99a784558c1d89973638911269e1cd0dc10c7
+  data.tar.gz: b6e993004b030f37f1e71926090aecfad292edf55346f53a8b77bde0dc5135b74979ad4de49525e54a2b23580bd3f013c5fd41bd6ec1821715894224a038ac3a

data/lib/cyclid/errors.rb

@@ -72,6 +72,17 @@ module Cyclid
       # Base class for all internal Cyclid exceptions
       class CyclidError < StandardError
       end
+
+      # Object was not found
+      class NotFoundError < CyclidError
+      end
+
+      # Object is invalid
+      class InvalidObjectError < CyclidError
+      end
+
+      class InternalError < CyclidError
+      end
     end
   end
 end

data/lib/cyclid/linter.rb

@@ -0,0 +1,191 @@
+#  Copyright 2017 Liqwyd Ltd.
+#
+#  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.
+
+require 'active_support'
+require 'active_support/core_ext'
+require 'json'
+require 'yaml'
+
+module Cyclid
+  # Module for the Cyclid job linter
+  module Linter
+    # A simple helper to track Warnings & Errors from the Verifier
+    class StatusLogger
+      attr_reader :messages, :warnings, :errors
+
+      module MessageTypes
+        WARNING = 0
+        ERROR = 1
+      end
+
+      def initialize
+        @messages = []
+        @warnings = 0
+        @errors = 0
+      end
+
+      def warning(message)
+        @warnings += 1
+        @messages << { type: MessageTypes::WARNING, text: message }
+      end
+
+      def error(message)
+        @errors += 1
+        @messages << { type: MessageTypes::ERROR, text: message }
+      end
+    end
+
+    # Verify (lint) a Job for obvious errors and potential problems
+    class Verifier
+      module Bertrand
+        UNKNOWN = 0
+        NOT_EXIST = 1
+        EXISTS = 2
+      end
+
+      attr_reader :status
+
+      def initialize(*_args)
+        @status = StatusLogger.new
+      end
+
+      def verify(definition)
+        job = definition.deep_symbolize_keys
+
+        # Does the data even look like a job?
+        @status.error 'Job is not a hash?' \
+          unless job.is_a? Hash
+
+        @status.error 'Job is empty?' \
+          if job.empty?
+
+        # Lint all of the obvious, top-level stuff that makes up a basic job
+        @status.error 'The Job does not have a name.' \
+          unless job.key? :name
+
+        @status.warning 'No version is defined for the Job. The default of 1.0.0 will be used.' \
+          unless job.key? :version
+
+        @status.warning 'No environment is defined. Defaults will apply.' \
+          unless job.key? :environment
+
+        @status.error 'No sequence is defined.' \
+          unless job.key? :sequence
+
+        # If any Stages are defined, check that each one looks valid
+        verify_stages(job[:stages]) if job.key? :stages
+
+        # Verify that the Sequence is valid, as much as possible
+        verify_sequence(job[:sequence]) if job.key? :sequence
+      rescue StandardError => ex
+        @status.error "An unexpected error occured during the verification: #{ex}"
+      end
+
+      private
+
+      def verify_stages(stages)
+        @status.error 'Stages is not defined as an Array.' \
+          unless stages.is_a? Array
+
+        @status.warning 'Stages is defined but empty?' \
+          if stages.empty?
+
+        # Verify each Stage
+        @ad_hoc_stages = []
+        stages.each do |stage|
+          unless stage.is_a? Hash
+            @status.error 'A Stage is defined but is not an Object?'
+            next
+          end
+
+          unless stage.key? :name
+            @status.error 'A Stage is defined without a name.'
+            next
+          end
+
+          # The Stage is at least a Hash with a name key...
+          name = stage[:name]
+          @ad_hoc_stages << name
+
+          @status.error "The Stage '#{name}' is defined but empty." \
+            if stage.empty?
+
+          unless stage.key? :steps
+            @status.error "The Stage '#{name}' does not define any Steps."
+            next
+          end
+
+          @status.error "The Stage '#{name}' defines an empty set of Steps." \
+            if stage[:steps].empty?
+
+          @status.warning "No version is given for the Stage '#{name}'. " \
+            'The default of 1.0.0 will be used.' \
+            unless stage.key? :version
+        end
+      end
+
+      def verify_sequence(sequence)
+        @status.error 'The Sequence is not defined as an Array.' \
+          unless sequence.is_a? Array
+
+        @status.error 'The Sequence is defined but empty?' \
+          if sequence.empty?
+
+        # Verify each Stage and track all dependencies (stage, on_success, on_failure)
+        dependencies = []
+        sequence.each do |stage|
+          unless stage.is_a? Hash
+            @status.error 'A Stage in the Sequence is defined that is not an Object?'
+            next
+          end
+
+          unless stage.key? :stage
+            @status.error 'A Stage in the Sequence does not name a Stage to run.'
+            next
+          end
+
+          name = stage[:stage]
+          @status.warning 'A Stage in the Sequence does not specify a version for the ' \
+            "Stage '#{name}'. The latest will always be used."
+
+          dependencies << name.downcase
+          dependencies << stage[:on_success].downcase if stage.key? :on_success
+          dependencies << stage[:on_failure].downcase if stage.key? :on_failure
+        end
+        dependencies.uniq!
+
+        # Check that every dependency exists
+        dependencies.each do |dep|
+          next if @ad_hoc_stages.include? dep
+
+          # Okay, it's not defined in this job: does it exist on the server?
+          case stage_exists? dep
+          when Bertrand::UNKNOWN
+            @status.warning "The Stage '#{dep}' in the Sequence is not defined in this job and " \
+              'may not exist on the server.'
+          when Bertrand::NOT_EXIST
+            @status.error "The Stage '#{dep}' in the Sequence is not defined in this job and " \
+              'does not exist on the server.'
+          end
+        end
+      end
+
+      # Find a Stage by it's name; this method will difer between Remote & Local
+      # (server-side) verification, so is just a stub here.
+      def stage_exists?(_name)
+        Bertrand::UNKNOWN
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cyclid-core
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kristian Van Der Vliet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-15 00:00:00.000000000 Z
+date: 2017-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 description: Core files (shared between the Client & Server) for Cyclid
 email: vanders@liqwyd.com
 executables: []
@@ -35,6 +49,7 @@ files:
 - lib/cyclid/constants.rb
 - lib/cyclid/errors.rb
 - lib/cyclid/hmac.rb
+- lib/cyclid/linter.rb
 homepage: 
 licenses:
 - MIT