oo-cartridge-tools 0.1

data/README.md

@@ -0,0 +1,46 @@
+# OpenShift Cartridge Lint
+
+The OpenShift Cartridge Lint is an utility which helps developers to test
+the validity and syntax of the cartridge metadata.
+
+In future this command will be expanded to provide more functionality, but for
+now you can use it to validate the cartridge 'manifest.yml' file to make sure
+you haven't missed some required attribute or you not made the syntax error.
+
+## Using oo-cartridge-lint
+
+### Dependencies:
+
+* [kwalify](http://www.kuwata-lab.com/kwalify)
+* [commander](http://visionmedia.github.io/commander)
+
+(Don't worry, these dependencies are installed automatically for you)
+
+### Installation:
+
+```
+$ gem install oo-cartridge-lint
+```
+
+(the Fedora/RHEL packages are TBD)
+
+### Usage:
+
+To check your current cartridge, you can run the following command:
+
+```
+$ cd cartridge-dir/
+$ oo-cartridge-lint manifest
+```
+
+The output should tell you if your manifest.yml has correct syntax or not. The
+sample output might look like this:
+
+```
+ ~/code/openshift-origin-cartridge-ruby → oo-cartridge-lint manifest --file metadata/manifest.yml.rhel
+[openshift-origin-cartridge-ruby/metadata/manifest.yml.rhel] INVALID
+  [/] - key 'Description:' is required.
+  [/Architecture] - 'arm': invalid Architecture value.
+```
+
+(Note: The --file option is optional, by default the command will check the `metadata/manifest.yml` path.

data/bin/oo-cartridge-lint

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+
+require_relative '../lib/openshift/cartridge_utils'
+
+program :name, 'OpenShift cartridge lint'
+program :version, '1.0.0'
+program :description, 'Validate the OpenShift cartridge'
+
+command :manifest do |c|
+  c.syntax = 'manifest'
+  c.description = 'Validates the manifest.yml'
+  c.option '--file STRING', String, 'The manifest.yml path (default: ./metadata/manifest.yml'
+  c.option '--schema STRING', String, 'Override the manifest.yaml kwalify schema'
+
+  c.action do |_, options|
+    manifest_file = OpenShift::CartridgeUtils::Lint.guess_manifest_path(options.file)
+    schema_file = OpenShift::CartridgeUtils::Lint.guess_schema_path(options.schema)
+    result = OpenShift::CartridgeUtils::Lint.parse(manifest_file, schema_file)
+    if result.errors?
+      say "[#{manifest_file}] INVALID"
+      result.errors.each { |e| say "  [#{e.path}] - #{e.message}" }
+      exit(1)
+    else
+      say "[#{manifest_file}] VALID"
+    end
+  end
+
+end

data/lib/openshift/cartridge_tools.rb

@@ -0,0 +1,5 @@
+module OpenShift
+  module CartridgeTools
+    require_relative './cartridge_tools/lint'
+  end
+end

data/lib/openshift/cartridge_tools/lint.rb

@@ -0,0 +1,57 @@
+require 'yaml'
+require 'kwalify'
+
+module OpenShift
+  module CartridgeTools
+
+    class Lint
+
+      CURRENT_MANIFEST_SCHEMA = "manifest_schema_20130929.yml"
+
+      def self.guess_manifest_path(file=nil)
+        base_path = Dir.pwd
+        unless file.nil?
+          file_path = File.join(base_path, file)
+        else
+          file_path = File.join(base_path, 'metadata', 'manifest.yml')
+        end
+        raise "File not found: #{file_path}" unless File.exists?(file_path)
+        return file_path
+      end
+
+      def self.guess_schema_path(schema=nil)
+        base_path = Dir.pwd
+        unless schema.nil?
+          schema_path = File.join(base_path, schema)
+        else
+          schema_path = File.join(File.dirname(__FILE__), '..', '..', '..', 'schema', CURRENT_MANIFEST_SCHEMA)
+        end
+        raise "Schema not found: #{schema_path}" unless File.exists?(schema_path)
+        return schema_path
+      end
+
+      def self.parse(manifest_file, schema_file=nil)
+        manifest = YAML.load_file(manifest_file)
+        schema = Kwalify::Yaml.load_file(schema_file)
+        validator = Kwalify::Validator.new(schema)
+        LintResult.get(validator.validate(manifest))
+      end
+
+      class LintResult
+        attr_accessor :errors
+
+        def initialize(errors)
+          @errors = errors
+        end
+
+        def self.get(validator)
+          self.new(validator)
+        end
+
+        def errors?; !errors.empty?; end
+      end
+
+    end
+
+  end
+end

data/schema/manifest_schema_20130929.yml

@@ -0,0 +1,165 @@
+&manifest
+type: map
+required: yes
+mapping:
+  "Name":
+    required: yes
+  "Cartridge-Short-Name":
+    required: yes
+    pattern: /[A-Z_]+/
+  "Display-Name":
+    required: yes
+  "Architecture":
+    enum: [ 'noarch', 'i386', 'x86_64' ]
+  "Description":
+    required: yes
+  "Version":
+    required: yes
+    pattern: /^([\d\.]+)$/
+  "Versions":
+    type: seq
+    sequence:
+      - { unique: yes }
+  "License":
+    required: yes
+  "License-Url":
+    pattern: /^http(s?):\/\//
+  "Vendor":
+    required: yes
+  "Cartridge-Version":
+    required: yes
+    pattern: /[0-9][0-9\.]*/
+  "Compatible-Versions":
+    type: seq
+    sequence:
+      - { unique: yes, pattern: "/[0-9][0-9\.]*/" }
+  "Cartridge-Vendor":
+    required: yes
+  "Categories":
+    type: seq
+    required: yes
+    sequence:
+      - { unique: yes, required: true, pattern: "/[a-z][a-z_]*/" }
+  "Website":
+    pattern: /^http(s?):\/\//
+  "Help-Topics":
+    type: map
+    mapping:
+      "Developer Center":
+      "=": { type: str }
+  "Cart-Data":
+    type: seq
+    sequence:
+      - type: map
+        mapping:
+          "Key":
+            required: true
+          "Type":
+            required: true
+            enum: [environment, cart_data]
+          "Description":
+            required: true
+  "Publishes": &publishes
+    type: map
+    mapping:
+      "=": 
+        type: map
+        mapping:
+          "Type":
+            pattern: /^(ENV|STRING|NET_TCP|NET_UDP|FILESYSTEM)\:/
+  "Subscribes": &subscribes
+    type: map
+    mapping:
+      "=":
+        type: map
+        mapping:
+          "Type":
+            pattern: /^(ENV|STRING|NET_TCP|NET_UDP|FILESYSTEM)\:/
+          "Required":
+            type: bool
+  "Scaling": &scaling
+    type: map
+    mapping:
+      "Min": &scale_type
+        type: int
+        range: { max: 10, min: -10 }
+      "Max": *scale_type
+      "Multiplier": *scale_type
+  "Provides":
+    type: seq
+    sequence:
+      - { unique: yes }
+  "Endpoints":
+    type: seq
+    sequence:
+      - type: map
+        mapping:
+          "Private-IP-Name": { required: yes, pattern: "/[A-Z][A-Z_]+/" }
+          "Private-Port-Name": { required: yes, pattern: "/[A-Z][A-Z_]+/" }
+          "Private-Port": { type: int, range: { min-ex: 1024 } }
+          "Public-Port-Name": { unique: yes, pattern: "/[A-Z][A-Z_]+/" }
+          "WebSocket-Port": { type: int, range: { min-ex: 1024 } }
+          "WebSocket-Port-Name": { unique: yes, pattern: "/[A-Z][A-Z_]+/" }
+          "Protocols":
+            type: seq
+            sequence:
+              - { unique: yes }
+          "Options":
+            type: map
+            mapping:
+              "ssl_to_gear": {type: bool}
+          "Mappings":
+            type: seq
+            sequence:
+              - type: map
+                mapping:
+                  "Frontend": { required: yes }
+                  "Backend": { required: yes }
+                  "Options":
+                    type: map
+                    mapping:
+                      "websocket": { type: any, enum: [true, false, 1, 0] }
+                      "health": {type: any, enum: [true, false, 1,0] }
+                      "target_update": { type: any, enum: [true, false, 1, 0] }
+                      "connections": { type: int }
+                      "file": {type: any, enum: [true, false, 1, 0] }
+                      "tohttps": {type: any, enum: [true, false, 1, 0] }
+  "Additional-Control-Actions":
+    type: seq
+    sequence:
+      - { unique: yes, enum: [threaddump]  }
+  "Configure-Order":
+    type: seq
+    sequence:
+      - { unique: yes, pattern: "/[a-z-]+/" }
+  "Group-Overrides":
+    type: seq
+    sequence:
+      - type: map
+        mapping:
+          "components":
+            type: seq
+            sequence:
+              - { type: str, unique: yes, pattern: "/[a-z-]+/" }
+  "Components":
+    type: map
+    mapping:
+      "=":
+        type: map
+        mapping:
+          "Publishes": *publishes
+          "Subscribes": *subscribes
+          "Scaling": *scaling
+  "Version-Overrides":
+    type: map
+    mapping:
+      "=":
+        type: map
+        mapping:
+          "=": { type: any }
+  "Suggests":
+    type: seq
+    sequence:
+      - { unique: yes }
+  "Install-Build-Required":
+    type: bool

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: oo-cartridge-tools
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Michal Fojtik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kwalify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Various utilities to help with OpenShift cartridge development
+email:
+- mfojtik@redhat.com
+executables:
+- oo-cartridge-lint
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/openshift/cartridge_tools.rb
+- lib/openshift/cartridge_tools/lint.rb
+- bin/oo-cartridge-lint
+- schema/manifest_schema_20130929.yml
+- README.md
+homepage: https://github.com/mfojtik/oo-cartridge-tools
+licenses:
+- ASL 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: OpenShift Cartridge utilities
+test_files: []