schema-evolution-manager 0.9.24 → 0.9.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f558b6d464ff5f0df460c0a6cfdc2a9b3eadc062
-  data.tar.gz: 59038ba0b4234da0ea505718d1846414fea3bb40
+  metadata.gz: bb6f13a7ee9457b87783a853e81388457ae38297
+  data.tar.gz: 6450ab24e9348ee9e21881256ba26081e97ddd8b
 SHA512:
-  metadata.gz: 0d52b58665bbb777cee7eff41648fcbd0b11d1b69528c47f1175a039bb516ffb0854c1ff1b027729661edbbc87402b7514f72fc984ca58f581a9af17a9acb2a0
-  data.tar.gz: 972a3132a497d487919031ec4acee6d25be979c73a5ac9727a92cb75ef821d947dacaec835675710909fe3c56929cae357b57d9b227da4a36f8d1cf15b003938
+  metadata.gz: 41f4a519bcb140564587b6f2faa2749be390523f86cac6520bb0b0f0af08ef213ec8b58ed58fbd74f607e92e4323f5ecb7ba44a1fd1f04e4602d834e5a6ffcb7
+  data.tar.gz: 9945e8b898c84a54ea1db077d862142cfa957b062d5d03f4268fb020f65b2b0f4cef1144cc123adc99a022ae8ed05c19f8ec7bc0b910202e7deb522074719840

data/README.md

@@ -103,8 +103,7 @@ manage and release schema changes independent of application changes:
 
 ## Talks
 
-First presented at PGDay NYC 2013:
-https://speakerdeck.com/mbryzek/schema-evolutions-at-gilt-groupe
+First presented at [PGDay NYC 2013](https://speakerdeck.com/mbryzek/schema-evolutions-at-gilt-groupe)
 
 ## Dependencies
 
@@ -116,19 +115,25 @@ https://speakerdeck.com/mbryzek/schema-evolutions-at-gilt-groupe
 
 - plpgsql must be available in the database. If needed you can:
 
-    createlang plpgsql template1
-    [http://www.postgresql.org/docs/8.4/static/app-createlang.html]
+  [createlang plpgsql template1](http://www.postgresql.org/docs/8.4/static/app-createlang.html)
 
 - Git: Designed to use git for history (all versions since 1.7).
 
 ## Installation
 
-    git clone git://github.com/mbryzek/schema-evolution-manager.git
-    cd schema-evolution-manager
-    git checkout 0.9.24
-    ruby ./configure.rb
-    sudo ./install.rb
+There are two ways to install schema evolution manager:
 
+1. Direct install using ruby (no dependency on ruby gems)
+
+        git clone git://github.com/mbryzek/schema-evolution-manager.git
+        cd schema-evolution-manager
+        git checkout 0.9.25
+        ruby ./configure.rb
+        sudo ./install.rb
+
+2. If you have ruby gems:
+
+        gem install schema-evolution-manager
 
 ## Upgrading
 
@@ -207,6 +212,24 @@ You will likely see a number of create table statements (see data model section
 which tells you that if you apply these changes, that sql script will be applied to the sample db
 
 
+### Specifying database password
+
+There are two recommended ways in which to pass user passwords to psql:
+
+ 1. Create a [~/.pgpass
+    file](http://www.postgresql.org/docs/9.4/static/libpq-pgpass.html)
+    with the appropriate credentials</li>
+
+ 2. Specify a [--password] flag when running sem-apply. You will
+    then be prompted to enter your password once. sem will create a
+    temporary file to store your password, using that file during the
+    duration of the command and ensuring the file is deleted after sem
+    completed.
+
+    Example:
+
+        sem-apply --url postgresql://postgres@localhost/sample --password
+
 ### Apply the changes
 
     sem-apply --url postgresql://postgres@localhost/sample
@@ -262,7 +285,7 @@ For details on these tables, see scripts/*sql where the tables themselves are de
 ## PLPGSQL Utilities
 
 We've included a copy of the schema conventions we practice at
-(Gilt Groupe)[CONVENTIONS.md]. There are also a number of utility plpgsql
+[Gilt Groupe](CONVENTIONS.md). There are also a number of utility plpgsql
 functions to help developers apply these conventions in a systematic way.
 
 The helpers are defined in
@@ -283,6 +306,7 @@ and utilities in practice.
 - sem-add: Adds a database upgrade script
 - sem-dist: Create a distribution tar.gz file containing schema upgrade scripts
 - sem-apply: Apply any deltas from a distribution tarball to a particular database
+- sem-baseline: Add any migration scripts to the schema tables without actually applying them. See [Migrating](#migrating)
 
 
 ## Attributes supported in sql migration scripts
@@ -311,15 +335,22 @@ Currently supported attributes:
       - -- sem.attribute.transaction = none
       - -- sem.attribute.transaction = single
 
+## Migrating
+
+In some cases you may be migrating from no schema evolutions, or another schema evolution model.
 
-## TODO
+For these cases, sem provides a 'baseline' command.
 
-- Consider offering an option to install via ruby gems
+Current workflow:
 
+  1. sem-add your current schema
+    1. Either via a database dump
+    1. Or by sem-adding existing DB scripts
+  1. Use sem-baseline to bootstrap the sem tables and add existing schema files to sem's migration table without actually applying them
 
 ## License
 
-Copyright 2013-2015 Gilt Groupe, Inc.
+Copyright 2013-2016 Gilt Groupe, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/bin/sem-apply

@@ -8,24 +8,28 @@
 #  sem-apply --host <database host> --user <db user> --name <db name>
 #
 # == Examples
-#  sem-apply --url postgresql://postgres@localhost/sample
+#  sem-apply --url postgresql://postgres@localhost:port/sample
 #  sem-apply --host localhost --user web --name test
 #
+require 'tempfile'
 
 load File.join(File.dirname(__FILE__), 'sem-config')
 
-args = SchemaEvolutionManager::Args.from_stdin(:optional => %w(url host port name user dry_run))
+args = SchemaEvolutionManager::Args.from_stdin(:optional => %w(url host port name user dry_run password))
 
-db = SchemaEvolutionManager::Db.from_args(args)
-db.bootstrap!
+password = if args.password
+             SchemaEvolutionManager::Ask.for_password("Please enter the database user password")
+           else
+             nil
+           end
 
-dry_run = args.dry_run.nil? ? false : args.dry_run
-
-util = SchemaEvolutionManager::ApplyUtil.new(db, :dry_run => dry_run)
-
-puts "Upgrading schema for #{db.url}"
+db = SchemaEvolutionManager::Db.from_args(args, :password => password)
+util = SchemaEvolutionManager::ApplyUtil.new(db, :dry_run => args.dry_run || false)
 
 begin
+  db.bootstrap!
+    
+  puts "Upgrading schema for #{db.url}"
   count = util.apply!("./scripts")
   if count == 0
     puts "  All scripts have been previously applied"

data/lib/schema-evolution-manager.rb

@@ -1,5 +1,6 @@
 require 'fileutils'
 require 'pathname'
+require 'io/console'
 
 dir = File.dirname(__FILE__)
 lib_dir = File.join(dir, "schema-evolution-manager")
@@ -16,6 +17,7 @@ load File.join(lib_dir, 'ask.rb')
 load File.join(lib_dir, 'version.rb')
 load File.join(lib_dir, 'args.rb')
 load File.join(lib_dir, 'scripts.rb')
+load File.join(lib_dir, 'connection_data.rb')
 load File.join(lib_dir, 'db.rb')
 load File.join(lib_dir, 'apply_util.rb')
 load File.join(lib_dir, 'baseline_util.rb')

data/lib/schema-evolution-manager/args.rb

@@ -19,13 +19,14 @@ module SchemaEvolutionManager
       }
 
       FLAGS_NO_ARGUMENTS = {
+        :password => "Prompt user to enter password for the database user. Password is stored for the duration of the process",
         :dry_run => "Include flag to echo commands that will run without actually executing them",
         :help => "Display help",
         :verbose => "Enable verbose logging of all system calls",
       }
     end
 
-    attr_reader :artifact_name, :host, :port, :name, :prefix, :url, :user, :dir, :dry_run, :tag
+    attr_reader :artifact_name, :host, :port, :name, :prefix, :url, :user, :dir, :dry_run, :tag, :password
 
     # args: Actual string arguments
     # :required => list of parameters that are required
@@ -52,7 +53,7 @@ module SchemaEvolutionManager
 
       @artifact_name = found_arguments.delete(:artifact_name)
       @host = found_arguments.delete(:host)
-      @port = found_arguments.delete(:port) 
+      @port = found_arguments.delete(:port)
       @name = found_arguments.delete(:name)
       @prefix = found_arguments.delete(:prefix)
       @url = found_arguments.delete(:url)
@@ -61,6 +62,7 @@ module SchemaEvolutionManager
       @tag = found_arguments.delete(:tag)
 
       @dry_run = found_arguments.delete(:dry_run)
+      @password = found_arguments.delete(:password)
       @help = found_arguments.delete(:help)
       @verbose = found_arguments.delete(:verbose)
 

data/lib/schema-evolution-manager/ask.rb

@@ -7,8 +7,13 @@ module SchemaEvolutionManager
     TRUE_STRINGS = ['y', 'yes'] unless defined?(TRUE_STRINGS)
 
     # Asks the user a question. Expects a string back.
+    #
+    # @param default: A default value
+    # @param echo: If true (the default), we echo what the user types
+    #        to the screen. If false, we do NOT echo.
     def Ask.for_string(message, opts={})
       default = opts.delete(:default)
+      echo = opts[:echo].nil? ? true : opts.delete(:echo)
       Preconditions.assert_empty_opts(opts)
 
       final_message = message.dup
@@ -19,7 +24,7 @@ module SchemaEvolutionManager
       value = nil
       while value.to_s == ""
         print final_message
-        value = get_input.strip
+        value = get_input(echo).strip
         if value.to_s == "" && default
           value = default.to_s.strip
         end
@@ -34,9 +39,17 @@ module SchemaEvolutionManager
       TRUE_STRINGS.include?(value.downcase)
     end
 
+    def Ask.for_password(message)
+      Ask.for_string(message, :echo => false)
+    end
+
     # here to help with tests
-    def Ask.get_input
-      STDIN.gets
+    def Ask.get_input(echo)
+      if echo
+        STDIN.gets
+      else
+        STDIN.noecho(&:gets)
+      end
     end
 
   end

data/lib/schema-evolution-manager/connection_data.rb

@@ -0,0 +1,68 @@
+module SchemaEvolutionManager
+
+  class ConnectionData
+
+    DEFAULT_PORT = 5432 unless defined?(DEFAULT_PORT)
+    
+    attr_reader :host, :name, :port, :user
+
+    def initialize(host, name, opts={})
+      @host = host
+      @name = name
+
+      port = opts.delete(:port).to_s
+      if port.to_s.empty?
+        @port = DEFAULT_PORT
+      else
+        @port = port.to_i
+      end
+      Preconditions.check_argument(@port > 0, "Port must be > 0")
+
+      @user = opts.delete(:user)
+      Preconditions.assert_empty_opts(opts)
+    end
+
+    # Returns a valid pgpass line entry representing this connection.
+    #
+    # @param password: Optional password to include in the connection string
+    def pgpass(password=nil)
+      [@host, @port, @name, @user, password.to_s].join(":")
+    end
+
+    # Parses a connection string into a ConnectionData instance. You
+    # will get an error if the URL could not be parsed.
+    #
+    # @param url e.g. postgres://user1@db.com:5553/test_db
+    def ConnectionData.parse_url(url)
+      protocol, rest = url.split("//", 2)
+      if rest.nil?
+        raise "Invalid url[%s]. Expected to start with postgres://" % url
+      end
+      
+      lead, name = rest.split("/", 2)
+      if name.nil?
+        raise "Invalid url[%s]. Missing database name" % url
+      end
+
+      parts = lead.split("@", 2)
+      if parts.size == 2
+        user = parts[0]
+        db_host = parts[1]
+      else
+        user = nil
+        db_host = lead
+      end
+
+      host, port = db_host.split(":", 2)
+      if port
+        if port.to_i.to_s != port
+          raise "Invalid url[%s]. Expected database port[%s] to be an integer" % [url, port]
+        end
+      end
+
+      ConnectionData.new(host, name, :user => user, :port => port)
+    end
+    
+  end
+
+end

data/lib/schema-evolution-manager/db.rb

@@ -4,8 +4,16 @@ module SchemaEvolutionManager
 
     attr_reader :url
 
-    def initialize(url)
+    def initialize(url, opts={})
       @url = Preconditions.check_not_blank(url, "url cannot be blank")
+      password = opts.delete(:password)
+      Preconditions.assert_empty_opts(opts)
+      connection_data = ConnectionData.parse_url(@url)
+
+      if password
+        ENV['PGPASSFILE'] = Library.write_to_temp_file(connection_data.pgpass(password))
+        puts "Created PGPASSFILE=%s" % ENV['PGPASSFILE']
+      end
     end
 
     # Installs schema_evolution_manager. Automatically upgrades schema_evolution_manager.
@@ -83,14 +91,18 @@ module SchemaEvolutionManager
       Db.from_args(args)
     end
 
-    def Db.from_args(args)
+    # @param password: Optional password to use when connecting to the database.
+    def Db.from_args(args, opts={})
       Preconditions.assert_class(args, Args)
+      password = opts.delete(:password)
+      Preconditions.assert_empty_opts(opts)
+
       if args.url
-        Db.new(args.url)
+        Db.new(args.url, :password => password)
       else
-        base = "%s:%s/%s" % [args.host || "localhost", args.port || 5432, args.name]
+        base = "%s:%s/%s" % [args.host || "localhost", args.port || ConnectionData::DEFAULT_PORT, args.name]
         url = args.user ? "%s@%s" % [args.user, base] : base
-        Db.new("postgres://" + url)
+        Db.new("postgres://" + url, :password => password)
       end
     end
 

data/lib/schema-evolution-manager/sem_version.rb

@@ -2,7 +2,7 @@ module SchemaEvolutionManager
 
   module SemVersion
 
-    VERSION = '0.9.24' # Automatically updated by util/create-release.rb
+    VERSION = '0.9.25' # Automatically updated by util/create-release.rb
 
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema-evolution-manager
 version: !ruby/object:Gem::Version
-  version: 0.9.24
+  version: 0.9.25
 platform: ruby
 authors:
 - Michael Bryzek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-28 00:00:00.000000000 Z
+date: 2016-03-28 00:00:00.000000000 Z
 dependencies: []
 description: '["Michael Bryzek"]'
 email: mbryzek@alum.mit.edu
@@ -35,6 +35,7 @@ files:
 - lib/schema-evolution-manager/args.rb
 - lib/schema-evolution-manager/ask.rb
 - lib/schema-evolution-manager/baseline_util.rb
+- lib/schema-evolution-manager/connection_data.rb
 - lib/schema-evolution-manager/db.rb
 - lib/schema-evolution-manager/install_template.rb
 - lib/schema-evolution-manager/library.rb