mobilis 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cd47dc94e879a945b060720f6ee453228b266749ebab21264f8a03c1af833ef
-  data.tar.gz: 22c7ce3af384fc3bda6b19790ea086919341466b8d37310d1c5b68fe5c169c6d
+  metadata.gz: a79181b97bf2572ac73e8dce659320884665aa649e955970d95bda0251c295dc
+  data.tar.gz: 303979cb4e400a188c6ca99d75f8c8857b4926661287e485b0999f0341f30611
 SHA512:
-  metadata.gz: 8e9064d8564ee716bc4d4dcf0806638ca3ce16036b6e3225593bf07a470a2fca3bb42da8a7bc63996b2fcf7aefa502b9311f53fbbe5a4434216cfe700c218eaf
-  data.tar.gz: a6f42ea29dd0b3605b3df3fe79bb768252bbc570cb5afdcb8a0c3245907af95bb8d7f5faefa687e057b4adf1feb686b60b66bfb7cfbc8f10f39649aed48598ba
+  metadata.gz: 561a375e73c458745e72415ab88ee6e19d7fe7b299a576ee2a619bc5e66e45ff4f25d763f8a58a2d8465661c6f861b6e5e1642c2e3f2da7084c57a5c5dbe2b2a
+  data.tar.gz: 02aabfdd670aeb2d7138b3507d36f15e4c2009656430ac9ec73c6829627f0e87f52949e8b9ce0d911786c24ed685e2ee1396a97a4cb98bb60fc829e2a0f26940

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [0.0.4] - 2022-09-11
+
+- Added command line options load and build
+- Added wait-until to rails w/postgresql or mysql to wait for the db to be ready before starting rails
+- Fixed per-state display not working
+- Use table_print to display some information such as linked projects
+
 ## [0.0.1] - 2022-06-26
 
 - Initial release

data/Gemfile.lock

@@ -1,9 +1,12 @@
 PATH
   remote: .
   specs:
-    mobilis (0.1.0)
+    mobilis (0.0.4)
       awesome_print
+      optimist
+      pry
       state_machine
+      table_print
       tty-prompt
 
 GEM
@@ -41,6 +44,7 @@ GEM
       attr_extras (>= 6.2.4)
       diff-lcs
       patience_diff
+    table_print (1.5.7)
     tty-color (0.6.0)
     tty-cursor (0.7.1)
     tty-prompt (0.23.1)

data/README.md

@@ -1,22 +1,44 @@
 # Mobilis
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mobilis`. To experiment with that code, run `bin/console` for an interactive prompt.
+Mobilis is a ruby app for generating linked sets of docker containers, for rapid
+prototyping of arbitrary project architecture.
 
-TODO: Delete this and the text above, and describe your gem
+It has some smarts built in to make common things simple, and will allow you to
+further customize the output for more complex needs.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+    $ gem install mobilis
 
-    $ bundle add mobilis
+## Usage
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+    $ mobilis
 
-    $ gem install mobilis
+This will start the console based user interface.
 
-## Usage
+Add projects of the various kinds.  The input doesn't save you from mistakes
+like entering spaces for service names, so don't do it.
+
+If you need any containers to connect to other containers via the internal
+names, you will want to add a link from the project that is connecting to the
+project that is being connected to.
+
+When configured to your liking, select the generate option to generate the
+projects.  This will *DESTROY* any data in an existing 'generate' directory.
 
-TODO: Write usage instructions here
+## Special Rails support
+If a Ruby on Rails project is linked to a postgres or mysql instance, it will
+be setup with a DATABASE_URL environment variable that has the connection
+information.
+
+In addition, the database instance will receive a environment variable with the
+name of the default production database that is based on the rails project's name
+
+## Security
+The generated projects are insecure, because of credential handling details.
+
+If you want to deploy the projects into a production environment, you are
+responsible for secrets management.
 
 ## Development
 
@@ -26,4 +48,13 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mobilis.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Meleneth/mobilis.
+
+## Plans
+
+Adding more project types + smart integrations
+Instrumenting generated projects with New Relic
+Smoothing out the flow of the UI
+Be able to load a previous configured set of projects for further editing
+~~Make generated rails projects wait at startup until the database is usable~~
+More details in TODO.md

data/TODO.md

@@ -0,0 +1,18 @@
+make links look better ( table_print )
+make link flow not redirect back to main menu
+write down every time a flow feels bad
+fix NR integration
+~~fix having to restart several times to go through db create, db migrate, start service loop~~
+add flask app
+rails: add interactive service designer (models / controllers)
+add a rack service wrapper that deploys as a sidecar (*handwave*)
+use graphviz to show a diagram for current metaproject
+~~give some documentation for expected usage / security concerns~~
+rails: add multi-db-at-once support
+add docker registry support (i.e. the docker container to host a docker registry)
+no matter if you create a db or a rails project first, the flow should be easy and obvious to add the other, associated with whatever you made first
+add ability to re-load old configuration
+if generate/data exists already with data, have an option to keep or wipe the data
+fix git integration so we have proper commit points between each step
+add command line builder, so you can generate a tree based on an existing config
+in a complex config, it feels bad when the config gets big

data/exe/mobilis

@@ -5,9 +5,11 @@ require 'pry'
 require "mobilis/command_line"
 require "mobilis/interactive_designer"
 
-# options parsing is TODO
-#options = Mobilis::CommandLine.parse_args(ARGV)
+options = Mobilis::CommandLine.parse_args(ARGV)
 program = Mobilis::InteractiveDesigner.new
+if options[:subcommand] == :load
+  program.load_from_file options[:filename]
+end
 program.go_main_menu
 
 loop do

data/lib/mobilis/command_line.rb

@@ -5,37 +5,23 @@ module Mobilis
     def self.parse_args(args)
       options = {}
       Optimist.options(args) do
-        banner "checklist code janitor"
-        stop_on ["new", "check", "add"]
+        banner "multi-project codebase generation toolkit"
+        stop_on ["load", "build", "help"]
       end
-      if args.length == 0
-        options[:subcommand] = :help
+      if args == []
+        options[:subcommand] = :interactive
         return options
       end
       options[:subcommand] = args.shift.to_sym
       case options[:subcommand]
-      when :new
-        Optimist.options(args) do
-          stop_on ["gem", "railsapp", "railsapi"]
-        end
-        options[:new_type] = args.shift.to_sym
-        options[:name] = case options[:new_type]
-        when :gem
-          args.shift
-        when :railsapp
-          args.shift
-        when :railsapi
-          args.shift
-        end
-      when :add
-        Optimist.options(args) do
-          stop_on ["gem", "docker"]
-        end
-        options[:add_type] = args.shift.to_sym
-        case options[:add_type]
-        when :gem
-          options[:name] = args.shift
-        end
+      when :load
+        options[:filename] = args.shift
+      when :build
+        options[:filename] = args.shift
+      when :help
+        puts "I think we'd all like a little help."
+      else
+        Optimist::die "unknown subcommand #{cmd.inspect}"
       end
       options
     end

data/lib/mobilis/docker_compose_projector.rb

@@ -73,10 +73,7 @@ def postgresql_service service
   {
     "image" => "postgres:14.1-alpine",
     "restart" => "always",
-    "environment" => [
-      "POSTGRES_USER=#{ service.name }",
-      "POSTGRES_PASSWORD=#{ service.password }"
-    ],
+    "environment" => service.env_vars,
     "ports" => ["#{ attributes[keyname] }:5432"],
     "volumes" => [
       "#{ service.data_dir }:/var/lib/postgresql/data"

data/lib/mobilis/interactive_designer.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require 'state_machine'
-require 'tty-prompt'
 require 'awesome_print'
 require 'forwardable'
+require 'state_machine'
+require 'table_print'
+require 'tty-prompt'
 
 require 'mobilis/logger'
 require 'mobilis/project'
@@ -16,7 +17,7 @@ extend Forwardable
 attr_accessor :project
 attr_reader :prompt
 
-def_delegators :@project, :projects, :display
+def_delegators :@project, :projects, :load_from_file
 
 state_machine :state, initial: :intialize do
 
@@ -44,6 +45,11 @@ state_machine :state, initial: :intialize do
     transition [:main_menu] => :add_redis_instance
   end
 
+  event :go_back do
+    transition [:edit_rails_project] => :main_menu
+    transition [:edit_generic_project] => :main_menu
+  end
+
   event :go_add_rack_project do
     transition [:main_menu] => :add_rack_project
   end
@@ -107,7 +113,10 @@ state_machine :state, initial: :intialize do
 
   state :main_menu do
     def display
-      project.display
+      puts
+      tp.set :max_width, 160
+      tp projects, 'name', 'type', 'options': lambda {|p| p.options.join ", "}
+      puts
     end
     def choices
       project_choices = projects.map do |project|
@@ -141,12 +150,18 @@ state_machine :state, initial: :intialize do
   end
 
   state :edit_links_select_project do
-    def display = false
+    def display
+      puts
+      tp.set :max_width, 160
+      tp projects, 'name', 'type', 'links': lambda {|p| p.links.join ", "}
+      puts
+    end
     def choices
       [
         {name: "return to Main Menu",          value: -> { go_main_menu }},
         *( projects.map do |project|
-             { name: "Edit '#{ project.name }' links", value: -> { @selected_project = project ; go_edit_links } }
+            links_txt = project.links.join ", "
+             { name: "Edit '#{ project.name }' links (#{ links_txt })", value: -> { @selected_project = project ; go_edit_links } }
            end)
       ]
     end
@@ -274,7 +289,7 @@ state_machine :state, initial: :intialize do
 
   state :toggle_rails_api_mode do
     def display
-      Mobilis.logger.info "Toggled rails API mode for '#{@selected_rails_project.name}'"
+      Mobilis.logger.info "Toggled rails API mode for '#{ @selected_rails_project.name }'"
     end
     def choices = false
     def action
@@ -347,10 +362,10 @@ def initialize
   @project = Project.new
 end
 
-
+##
+# display, choices, and action methods all change per-state
 def choose_destination
   Mobilis.logger.info "#choose_destination"
-
   blank_space
   spacer
   display

data/lib/mobilis/postgresql_instance.rb

@@ -13,6 +13,17 @@ def child_env_vars
   [ ]
 end
 
+def env_vars
+  vars = []
+  if linked_to_rails_project
+    vars << "POSTGRES_DB=#{ linked_to_rails_project.name }_production"
+  end
+  vars.concat [
+   "POSTGRES_USER=#{ name }",
+   "POSTGRES_PASSWORD=#{ password }"
+  ]
+end
+
 def data_dir
   "./data/#{ name }"
 end

data/lib/mobilis/project.rb

@@ -159,6 +159,11 @@ def build_rails_builder
   run_docker "build -t #{ rails_builder_image } ."
 end
 
+def load_from_file filename
+  data = File.read filename
+  @data = JSON.parse data, {:symbolize_names => true}
+end
+
 def save_project
   File.open("mproj.json", "w") do |f|
     f.write(JSON.pretty_generate(@data))
@@ -181,7 +186,7 @@ def projects
     redis: RedisInstance,
     rack: RackProject
   }
-  @data[:projects].map {|p| mapping[p[:type]].new p, self}
+  @data[:projects].map {|p| mapping[p[:type].to_sym].new p, self}
 end
 
 def project_by_name name

data/lib/mobilis/rack_project.rb

@@ -21,7 +21,8 @@ def generate
 end
 
 def generate_config_ru
-  set_file_contents "config.ru", '# config.ru
+  set_file_contents "config.ru", <<CONFIG_RU
+# config.ru
 app = Proc.new {
   [
     200,
@@ -30,11 +31,12 @@ app = Proc.new {
   ]
 }
 run app
-'
+CONFIG_RU
 end
 
 def generate_Gemfile
-  set_file_contents "Gemfile", '# frozen_string_literal: true
+  set_file_contents "Gemfile", <<GEMFILE
+# frozen_string_literal: true
 
 source "https://rubygems.org"
 
@@ -43,11 +45,12 @@ source "https://rubygems.org"
 gem "rack", "= 3.0.0.beta1"
 
 gem "rackup", "~> 0.2.2"
-'
+GEMFILE
 end
 
 def generate_Gemfile_lock
-  set_file_contents "Gemfile.lock", 'GEM
+  set_file_contents "Gemfile.lock", <<GEMFILE_LOCK
+GEM
   remote: https://rubygems.org/
   specs:
     rack (3.0.0.beta1)
@@ -65,11 +68,11 @@ DEPENDENCIES
 
 BUNDLED WITH
    2.3.16
-'
+GEMFILE_LOCK
 end
 
 def generate_Dockerfile
-  set_file_contents "Dockerfile", '
+  set_file_contents "Dockerfile", <<DOCKER_END
 FROM ruby:latest
 RUN apt-get update -qq && apt-get install -y nodejs postgresql-client
 WORKDIR /myapp
@@ -79,10 +82,9 @@ RUN bundle install
 COPY . /myapp
 
 # Add a script to be executed every time the container starts.
-ENTRYPOINT ["rackup"]
+ENTRYPOINT ["rackup", "-o", "#{ name }"]
 EXPOSE 9292
-
-'
+DOCKER_END
 end
 
 end

data/lib/mobilis/rails_project.rb

@@ -81,6 +81,7 @@ def generate
     install_rspec if options.include? :rspec
     install_factory_bot if options.include? :factory_bot
     git_commit_all "add Gems"
+    generate_wait_until
     generate_Dockerfile
     generate_entrypoint_sh
     generate_build_sh
@@ -96,10 +97,36 @@ def rails_master_key
   @data[:attributes][:rails_master_key]
 end
 
+def generate_wait_until
+  set_file_contents 'wait-until', <<WAITUNTIL
+#!/usr/bin/env bash
+# https://github.com/nickjj/wait-until under MIT license
+
+command="${1}"
+timeout="${2:-30}"
+
+i=1
+until eval "${command}"
+do
+    ((i++))
+
+    if [ "${i}" -gt "${timeout}" ]; then
+        echo "command was never successful, aborting due to ${timeout}s timeout!"
+        exit 1
+    fi
+
+    sleep 1
+done
+WAITUNTIL
+end
+
+
 def generate_Dockerfile
-  set_file_contents "Dockerfile", 'FROM ruby:latest
-RUN apt-get update -qq && apt-get install -y nodejs postgresql-client dos2unix
+  set_file_contents "Dockerfile", <<DOCKER_END
+FROM ruby:latest
+RUN apt-get update -qq && apt-get install -y nodejs postgresql-client default-mysql-client dos2unix
 WORKDIR /myapp
+COPY wait-until /myapp/wait-until
 COPY Gemfile /myapp/Gemfile
 COPY Gemfile.lock /myapp/Gemfile.lock
 RUN bundle install
@@ -113,11 +140,12 @@ RUN dos2unix /myapp/entrypoint.sh
 
 # Configure the main process to run when running the image
 CMD ["rails", "server", "-b", "0.0.0.0"]
-'
+DOCKER_END
 end
 
 def generate_entrypoint_sh
-  set_file_contents "entrypoint.sh", "#!/bin/sh
+  set_file_contents "entrypoint.sh", <<ENTRYPOINT_SH
+#!/bin/sh
 
 # https://stackoverflow.com/a/38732187/1935918
 set -e
@@ -125,11 +153,25 @@ set -e
 if [ -f /app/tmp/pids/server.pid ]; then
   rm /app/tmp/pids/server.pid
 fi
-
+#{ wait_until_line }
 bundle exec rake db:migrate 2>/dev/null || bundle exec rake db:setup
 
-exec bundle exec \"$@\"
-"
+exec bundle exec "$@"
+ENTRYPOINT_SH
+end
+
+def wait_until_line
+  if database.instance_of? Mobilis::PostgresqlInstance
+    return <<POSTGRES_LINE
+/myapp/wait-until "psql postgres://#{ database.username }:#{ database.password }@#{ database.name }/#{ name }_production -c 'select 1'"
+POSTGRES_LINE
+  end
+# instance_of? is a code smell - maybe this should be database.wait_until_line ?
+  if database.instance_of? Mobilis::MysqlInstance
+    return <<MYSQL_LINE
+/myapp/wait-until "mysql -D #{ name }_production -h #{ database.name } -u #{ database.username } -p#{ database.password } -e 'select 1'"
+MYSQL_LINE
+  end
 end
 
 def install_rspec

data/lib/mobilis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mobilis
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/mobilis.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "mobilis/version"
+require_relative "mobilis/command_line"
 require_relative "mobilis/project"
 require_relative "mobilis/docker_compose_projector"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mobilis
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Meleneth
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-20 00:00:00.000000000 Z
+date: 2022-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: state_machine
+  name: optimist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tty-prompt
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: state_machine
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: optimist
+  name: table_print
+  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: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,6 +123,7 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- TODO.md
 - exe/mobilis
 - lib/mobilis.rb
 - lib/mobilis/actions_projects_take.rb