sprawl 0.1.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at crohr@fortitudetec.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in servitude.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Fortitude Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# Sprawl
+
+One challenge in the microservice world is tracking service relationships as an application grows.  
+
+Enter Sprawl!
+
+Sprawl is a simple tool that generates a relationship map or diagram of the microservice components that make up an application based on a simple set of description files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sprawl'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sprawl
+
+## Usage
+
+### CLI
+
+Run `sprawl`
+
+### Service description
+
+In order to define a service you need a yaml file created with the following structure:
+
+```ruby
+name: first-service
+description: This is our first service
+language: Java
+datastores:
+  - Postgres
+messageTypesProduced:
+  - HelloThere
+  - Status
+messageTypesConsumed:
+  - ByeBye
+  - DoIt
+restDependencies:
+  - second-service
+  - third-service
+```
+
+| Field                | Description                                                                                                        |
+| -------------------- | ------------------------------------------------------------------------------------------------------------------ |
+| name                 | The name of the current service (REQUIRED)                                                                         |
+| description          | A short description of the purpose of the service                                                                  |
+| language             | The programming language that the service is written in                                                            |
+| datastores           | An array of any datastores that the service uses                                                                   |
+| messageTypesProduced | If the service utilizes asyncronous messaging, an array of message types that the service produces for the system  |
+| messageTypesConsumed | If the service utilizes asyncronous messaging, an array of message types that the service consumes from the system |
+| restDependencies     | An array of other services that this service communicates over REST                                                |
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fortitudetec/sprawl. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sprawl'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/sprawl

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'sprawl/cli'
+
+cli = Sprawl::Cli.new
+cli.run

data/lib/sprawl/cli.rb

@@ -0,0 +1,63 @@
+require 'sprawl/version'
+require 'sprawl/definition_loader'
+require 'sprawl/drawers/graphviz_drawer'
+require 'optparse'
+
+module Sprawl
+  class Cli
+    def run
+      options = parse_options
+      defs = load_defs(options)
+
+      # TODO: Probably want to allow for different rendering engines
+      GraphvizDrawer.draw(defs, options[:output])
+    end
+
+    private
+
+    def parse_options
+      options = {}
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: sprawl [options]'
+
+        opts.on('-d DIRECTORY', '--directory=DIRECTORY', 'Locate definition files in given directory') do |d|
+          options[:directory] = d
+          options[:location_type] = :directory
+        end
+
+        opts.on('-g REPOSITORIES',
+                '--group-of-repositories=REPOSITORIES',
+                Array,
+                'Locate definition files across many git repositories (SERVITUDE files)') do |g|
+          options[:group] = g
+          options[:location_type] = :group
+        end
+
+        opts.on('-h', '--help', 'Prints this help') do
+          puts opts
+          exit
+        end
+
+        opts.on('-o OUTPUTTYPE', '--output-type=OUTPUTTYPE', 'Format of output (SVG, PNG, Text, HTML)') do |o|
+          options[:output] = o
+        end
+
+        opts.on('-s REPOSITORY',
+                '--single-repository=REPOSITORY',
+                'Locate all definition files in a single git repository') do |s|
+          options[:single] = s
+          options[:location_type] = :single
+        end
+
+        opts.on('-v', '--[no-]verbose', 'Runs verbosely') do |v|
+          options[:verbose] = v
+        end
+      end.parse!
+      options
+    end
+
+    def load_defs(options)
+      DefinitionLoader.load(options)
+    end
+  end
+end

data/lib/sprawl/definition_loader.rb

@@ -0,0 +1,22 @@
+require 'sprawl/loaders/directory_loader'
+require 'sprawl/loaders/single_git_loader'
+require 'sprawl/loaders/multi_git_loader'
+
+module Sprawl
+  class DefinitionLoader
+    TYPES = {
+      directory: DirectoryLoader,
+      single: SingleGitLoader,
+      group: MultiGitLoader
+    }.freeze
+
+    def self.load(options)
+      puts 'Loading Service Definitions' if options[:verbose]
+      service_definitions = TYPES[options[:location_type]].load(options)
+
+      puts "Loaded service definitions: #{service_definitions.inspect}" if options[:verbose]
+
+      service_definitions
+    end
+  end
+end

data/lib/sprawl/drawers/graphviz_drawer.rb

@@ -0,0 +1,52 @@
+require 'ruby-graphviz'
+
+module Sprawl
+  class GraphvizDrawer
+    def self.draw(defs, output)
+      graph = ::GraphViz.new(:G, type: :digraph)
+
+      nodes = generate_nodes(graph, defs)
+
+      # Generate the edges
+      defs.each do |d|
+        add_rest_connections(graph, nodes, d)
+        add_async_connections(graph, nodes, d, defs)
+      end
+
+      graph.output(svg: 'graph.svg') if output.casecmp('SVG').zero?
+      graph.output(png: 'graph.png') if output.casecmp('PNG').zero?
+    end
+
+    def self.generate_nodes(graph, defs)
+      nodes = {}
+
+      defs.each do |d|
+        nodes[d.name] = graph.add_nodes(d.name)
+      end
+
+      nodes
+    end
+
+    def self.add_rest_connections(graph, nodes, service)
+      return if service.rest_dependencies.nil?
+
+      service.rest_dependencies.each do |r|
+        graph.add_edges(nodes[service.name], nodes[r])
+      end
+    end
+
+    def self.add_async_connections(graph, nodes, service, all_services)
+      return if service.message_types_produced.nil?
+
+      service.message_types_produced.each do |t|
+        defs_consuming = all_services.reject do |consuming_def|
+          consuming_def.message_types_consumed.nil? || !consuming_def.message_types_consumed.include?(t)
+        end
+
+        defs_consuming.each do |c|
+          graph.add_edges(nodes[service.name], nodes[c.name], style: 'dashed')
+        end
+      end
+    end
+  end
+end

data/lib/sprawl/loaders/directory_loader.rb

@@ -0,0 +1,27 @@
+require 'yaml'
+require 'sprawl/service_definition'
+
+module Sprawl
+  class DirectoryLoader
+    def self.load(options)
+      puts 'Using Directory Loader' if options[:verbose]
+
+      service_definitions = []
+
+      Dir.foreach(options[:directory]) do |f|
+        next if File.directory?(f)
+
+        puts "Loading definition #{f}" if options[:verbose]
+        begin
+          service_definitions << Sprawl::ServiceDefinition.from(YAML.load_file(File.join(options[:directory], f)))
+        rescue
+          puts "Failed to load #{f}.  Trying the rest."
+        end
+      end
+
+      puts "Loaded #{service_definitions.size} service definitions" if options[:verbose]
+
+      service_definitions
+    end
+  end
+end

data/lib/sprawl/loaders/multi_git_loader.rb

@@ -0,0 +1,43 @@
+require 'yaml'
+require 'fileutils'
+require 'sprawl/service_definition'
+
+module Sprawl
+  class MultiGitLoader
+    def self.load(options)
+      puts 'Using Multi Git Loader' if options[:verbose]
+
+      begin
+        # Make temp directory
+        Dir.mkdir('.sprawl')
+
+        pull_repos(options[:group])
+
+        service_definitions = []
+
+        Dir.glob('.sprawl/**/SPRAWL').each do |def_file|
+          puts "Loading definition #{def_file}" if options[:verbose]
+
+          begin
+            service_definitions << Sprawl::ServiceDefinition.from(YAML.load_file(File.join(def_file)))
+          rescue
+            puts "Failed to load #{def_file}.  Trying the rest."
+          end
+        end
+      ensure
+        FileUtils.rm_rf('.sprawl')
+      end
+
+      service_definitions
+    end
+
+    def pull_repos(urls)
+      urls.each do |url|
+        puts "Pulling git repository of definitions from #{url}" if options[:verbose]
+        Dir.chdir('.servitude') do
+          `git clone #{url}`
+        end
+      end
+    end
+  end
+end

data/lib/sprawl/loaders/single_git_loader.rb

@@ -0,0 +1,28 @@
+require 'fileutils'
+require 'sprawl/service_definition'
+require 'sprawl/loaders/directory_loader'
+
+module Sprawl
+  class SingleGitLoader
+    def self.load(options)
+      puts 'Using Single Git Loader' if options[:verbose]
+      puts "Pulling git repository of definitions from #{options[:single]}" if options[:verbose]
+
+      service_definitions = []
+      begin
+        # Make temp directory
+        Dir.mkdir('.sprawl')
+
+        # Clone repo
+        `git clone #{options[:single]} .sprawl`
+
+        # run Directory loader
+        service_definitions = Sprawl::DirectoryLoader.load(directory: '.sprawl', verbose: options[:verbose])
+      ensure
+        FileUtils.rm_rf('.sprawl')
+      end
+
+      service_definitions
+    end
+  end
+end

data/lib/sprawl/service_definition.rb

@@ -0,0 +1,23 @@
+module Sprawl
+  class ServiceDefinition
+    attr_accessor :name,
+                  :description,
+                  :language,
+                  :datastores,
+                  :message_types_consumed,
+                  :message_types_produced,
+                  :rest_dependencies
+
+    def self.from(attributes)
+      definition = ServiceDefinition.new
+
+      return definition if attributes.nil?
+
+      attributes.each do |k, v|
+        definition.send("#{k}=", v) if definition.respond_to?("#{k}=")
+      end
+
+      definition
+    end
+  end
+end

data/lib/sprawl/version.rb

@@ -0,0 +1,3 @@
+module Sprawl
+  VERSION = '0.1.0'.freeze
+end

data/lib/sprawl.rb

@@ -0,0 +1,6 @@
+require 'sprawl/version'
+require 'sprawl/service_definition'
+
+module Sprawl
+  # Your code goes here...
+end

data/sprawl.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sprawl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sprawl'
+  spec.version       = Sprawl::VERSION
+  spec.authors       = ['Chris Rohr', 'Mike Bevels']
+  spec.email         = ['crohr@fortitudetec.com', 'mbevels@fortitudetec.com']
+
+  spec.summary       = 'Microservice Relationship Visualization Tool'
+  spec.description   = 'Utility to generate a visualization of the relationships in a microservice based system'
+  spec.homepage      = 'https://github.com/fortitudetec/sprawl'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'ruby-graphviz'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.45'
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: sprawl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Rohr
+- Mike Bevels
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+description: Utility to generate a visualization of the relationships in a microservice
+  based system
+email:
+- crohr@fortitudetec.com
+- mbevels@fortitudetec.com
+executables:
+- sprawl
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/sprawl
+- lib/sprawl.rb
+- lib/sprawl/cli.rb
+- lib/sprawl/definition_loader.rb
+- lib/sprawl/drawers/graphviz_drawer.rb
+- lib/sprawl/loaders/directory_loader.rb
+- lib/sprawl/loaders/multi_git_loader.rb
+- lib/sprawl/loaders/single_git_loader.rb
+- lib/sprawl/service_definition.rb
+- lib/sprawl/version.rb
+- sprawl.gemspec
+homepage: https://github.com/fortitudetec/sprawl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Microservice Relationship Visualization Tool
+test_files: []