p4util 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7427b07b614b4b912c90eacd5d9d304c773b239
+  data.tar.gz: 29a165e47defc8e7c1bdc71d248f95c8532caeb8
+SHA512:
+  metadata.gz: b1b00491f1b0dd76e43fda03fefed8aff019c0227a30e7caf5a7428529e116123da920a0b9e1eae244b713b1e95529b1b4a0dda124712a4f364b2dcb073b3d65
+  data.tar.gz: 0d5458e1b84fe0b6bec09381287d55333dfd7b439188ec0efb62430b1be4405d7f49ad183be4f691d597fb703016dc90c5687f7e4c517ae9954ebdaeae9bc090

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Perforce Software, Inc.
+
+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,31 @@
+# P4util
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'p4util'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install p4util
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/p4util/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/p4util

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+#
+# A simplified wrapper to launch our application code mostly defined under the
+#
+lib_path = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib_path)
+require 'p4_util'
+
+P4Util::run ARGV

data/lib/commands/download.rb

@@ -0,0 +1,89 @@
+require 'conventions'
+require 'optparse'
+require 'osutil'
+require 'net/ftp'
+
+module Commands
+
+  def Commands.download(options=nil)
+    version = 'r14.2'
+    binary = 'p4d'
+
+    if options and !options.params.empty?
+
+      op = OptionParser.new do |op|
+        op.on('-v VERSION', '--version VERSION', 'ftp.perforce.com version') do |v|
+          version = v
+        end
+      end
+
+      op.parse!(options.params)
+
+      if !options.params.empty?
+        binary = options.params.first
+      end
+    end
+
+    case binary
+      when 'p4d'
+        download_p4d_via_ftp(version)
+      when 'p4api'
+        download_p4api_via_ftp(version)
+      else
+        raise "Don't know how to download #{binary}, check 'p4util help download'"
+    end
+  end
+
+  def Commands.print_download_help
+    puts <<-END.gsub(/^ {6}/, '')
+      p4util download [p4d|p4api]
+
+      Downloads one of the following utilities (in lieu of an installer) into
+      a local work/ directory.
+
+      * p4d
+      * p4api
+
+      Will default to the latest release unless you don't know what that is.
+
+      Options:
+
+      --version X where X looks like the version in the ftp.perforce.com site,
+                e.g., 'r14.2' instead of '2014.2'
+    END
+  end
+
+  private
+
+  def Commands.download_p4d_via_ftp(version)
+    download_via_ftp(version, OsUtil.p4d_executable, OsUtil.p4d_path)
+
+    if !File.executable?(OsUtil.p4d_path)
+      File.chmod(0755, OsUtil.p4d_path)
+    end
+  end
+
+  def Commands.download_p4api_via_ftp(version)
+    download_via_ftp(version, OsUtil.p4api_file, OsUtil.p4api_path)
+
+    # um, probably should expand this guy out
+  end
+
+  private
+
+  def Commands.download_via_ftp(version, filename, output_path)
+    ftp = Net::FTP.new('ftp.perforce.com')
+    ftp.login
+
+    dir = OsUtil.ftp_download_dir(version)
+    ftp.chdir(dir)
+
+    ftp.passive=true
+
+    Conventions.init_working_dir
+
+    ftp.getbinaryfile(filename, output_path)
+  ensure
+    ftp.close if ftp and !ftp.closed?
+  end
+end

data/lib/commands/help.rb

@@ -0,0 +1,30 @@
+
+module Commands
+
+  def Commands.help(options)
+    if !options.params.empty? && Commands.respond_to?(options.params.first.to_sym)
+      method_name = "print_#{options.params.first}_help".to_sym
+      Commands.method(method_name).call()
+    else
+      print_general_help
+    end
+  end
+
+  private
+
+  def Commands.print_general_help
+    puts <<-END.gsub(/^ {6}/, '')
+      p4util [command] [params]
+
+      Executes various commands useful when writing Perforce applications.
+
+      Use `p4util help [command]` for more information on each command.
+
+      List of available commands:
+        download - Download Perforce binaries for your platform
+        init - Seed the local p4d instance using local configuration files
+        kill - Shutdown p4d processes using SIGTERM
+        start - Spawn the p4d process in your working directory
+    END
+  end
+end

data/lib/commands/kill.rb

@@ -0,0 +1,24 @@
+require 'sys/proctable'
+
+include Sys
+
+module Commands
+
+  def Commands.kill(options=nil)
+    ProcTable.ps().find_all{|p| p.comm =~ /p4d/}
+                  .each{|p| Process.kill('TERM', p.pid)}
+  end
+
+  def Commands.print_kill_help
+    puts <<-END.gsub(/^ {6}/,'')
+      p4util kill
+
+      Finds local p4d processes and kills them.
+
+      There should be a timeout that will force kill anything that appears stuck.
+
+      On unix machines, will probably use `ps -x` and 'p4d', then will send
+      SIGTERM signals to each process.
+    END
+  end
+end

data/lib/commands/start.rb

@@ -0,0 +1,31 @@
+
+module Commands
+
+  def Commands.start(options)
+    if !File.exists?(OsUtil.p4d_path)
+      Commands.download
+    end
+    Conventions.init_p4droot_dir
+    spawn_p4d
+  end
+
+  def Commands.spawn_p4d
+    pid = Process.spawn("#{OsUtil.p4d_path} -r #{Conventions.p4droot_dir} "+
+                        "-v server=1 -L #{Conventions.p4d_log_path}")
+    Process.detach(pid)
+  end
+
+  def Commands.print_start_help
+    puts <<-END.gsub(/^ {6}/,'')
+      p4util start
+
+      Spawns a Perforce process in your local work/p4droot directory.
+
+      If the Perforce executable does not exist, will download the binary first.
+
+      Will try to set up a server log at work/server.log. It'll be fairly
+      verbose by default; this is *not* intended for any kind of performance
+      testing.
+    END
+  end
+end

data/lib/commands.rb

@@ -0,0 +1,4 @@
+require 'commands/download'
+require 'commands/help'
+require 'commands/kill'
+require 'commands/start'

data/lib/conventions.rb

@@ -0,0 +1,29 @@
+
+require 'fileutils'
+
+module Conventions
+
+  def Conventions.working_dir
+    File.expand_path('work')
+  end
+
+  def Conventions.init_working_dir
+    if !File.directory?(working_dir)
+      FileUtils::makedirs(working_dir)
+    end
+  end
+
+  def Conventions.p4droot_dir
+    File.expand_path(File.join(working_dir,'p4droot'))
+  end
+
+  def Conventions.init_p4droot_dir
+    if !File.directory?(p4droot_dir)
+      FileUtils::makedirs(p4droot_dir)
+    end
+  end
+
+  def Conventions.p4d_log_path
+    File.expand_path(File.join(working_dir, 'server.log'))
+  end
+end

data/lib/osutil.rb

@@ -0,0 +1,52 @@
+
+require 'rbconfig'
+
+module OsUtil
+
+  def OsUtil.p4d_executable
+    if windows?
+      'p4d.exe'
+    else
+      'p4d'
+    end
+  end
+
+  def OsUtil.p4d_path
+    File.expand_path(File.join(Conventions.working_dir, OsUtil.p4d_executable))
+  end
+
+  def OsUtil.osx?
+    RbConfig::CONFIG['host_os'] =~ /darwin/
+  end
+
+  def OsUtil.windows?
+    RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+  end
+
+  def OsUtil.platform_dir_prefix
+    if osx?
+      'darwin90'
+    elsif windows?
+      'nt'
+    else
+      raise "OsUtil doesn't know platform: #{RbConfig::CONFIG['host_os']}"
+    end
+  end
+
+  def OsUtil.ftp_download_dir(version)
+    "perforce/#{version}/bin.#{platform_dir_prefix}#{RbConfig::CONFIG['build_cpu']}"
+  end
+
+  def OsUtil.p4api_file
+    if windows?
+      raise 'hey you need a visual studio version defined somehow'
+      'p4api.zip'
+    else
+      'p4api.tgz'
+    end
+  end
+
+  def OsUtil.p4api_path
+    File.expand_path(File.join(Conventions.working_dir, OsUtil.p4api_file))
+  end
+end

data/lib/p4_util/version.rb

@@ -0,0 +1,3 @@
+module P4Util
+  VERSION = "0.0.1"
+end

data/lib/p4_util.rb

@@ -0,0 +1,29 @@
+require 'p4_util/version'
+require 'commands'
+require 'optparse'
+require 'ostruct'
+
+module P4Util
+
+  def P4Util.run(args)
+    options = parse_options(args)
+    Commands.method(options.command).call(options)
+  end
+
+  # Returns the options as an OpenStruct object
+  def P4Util.parse_options(args)
+    options = OpenStruct.new
+
+    options.command = :help
+    options.params = []
+
+    if args && !args.empty?
+      options.command = args.first.to_sym
+      if args.length > 1
+        options.params.concat(args.drop(1))
+      end
+    end
+
+    options
+  end
+end

data/p4util.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'p4_util/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'p4util'
+  spec.version       = P4Util::VERSION
+  spec.authors       = ['Tristan Juricek']
+  spec.email         = ['tjuricek@perforce.com']
+  spec.summary       = %q{The p4util command line app eases setup of Perforce instances, mostly for testing.}
+  spec.description   = %q{The p4util command itself provides other commands, see 'p4util help' after install. This allows you to things like download a p4d, start it, kill it, etc mostly for quick setup of testing systems.}
+  spec.homepage      = 'http://perforce.com'
+  spec.license       = 'MIT'
+
+  spec.files         = `find . -type f -not -path '*/\.*' -not -name '*.lock'`.split
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_runtime_dependency 'sys-proctable', '~> 0.9'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: p4util
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tristan Juricek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: sys-proctable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: The p4util command itself provides other commands, see 'p4util help'
+  after install. This allows you to things like download a p4d, start it, kill it,
+  etc mostly for quick setup of testing systems.
+email:
+- tjuricek@perforce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./Gemfile"
+- "./LICENSE.txt"
+- "./README.md"
+- "./Rakefile"
+- "./bin/p4util"
+- "./lib/commands.rb"
+- "./lib/commands/download.rb"
+- "./lib/commands/help.rb"
+- "./lib/commands/kill.rb"
+- "./lib/commands/start.rb"
+- "./lib/conventions.rb"
+- "./lib/osutil.rb"
+- "./lib/p4_util.rb"
+- "./lib/p4_util/version.rb"
+- "./p4util.gemspec"
+homepage: http://perforce.com
+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.2.2
+signing_key: 
+specification_version: 4
+summary: The p4util command line app eases setup of Perforce instances, mostly for
+  testing.
+test_files: []