cfoundry_helper 0.2.1

data/.gitignore

@@ -0,0 +1,8 @@
+.idea
+.idea/*
+config/services.yml
+config/services.yml.b*
+pkg/
+pkg/*
+.DS_Store
+bin/.DS_Store

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/integration-test-support"]
+	path = vendor/integration-test-support
+	url = git@github.com:cloudfoundry/integration-test-support.git

data/CHANGELOG.textile

@@ -0,0 +1,10 @@
+h1. v0.1.0
+* OrganizationHelper implementation
+* ClientHelper implementation
+* UserHelper implementation
+
+h2. v0.2.0
+* add users to org script
+
+h2. v0.2.1
+* Bugfix: Don't cache the cloud controller client since the access token expires in long running apps.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    cfoundry_helper (0.2.1)
+      activesupport
+      cfoundry
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.13)
+    builder (3.1.4)
+    cf-uaa-lib (2.0.0)
+      multi_json
+    cfoundry (4.3.6)
+      activemodel (>= 3.2.13, < 5.0.0)
+      cf-uaa-lib (~> 2.0.0)
+      multi_json (~> 1.7)
+      multipart-post (~> 1.1)
+      rubyzip (~> 0.9)
+    coderay (1.0.9)
+    columnize (0.3.6)
+    daemons (1.1.9)
+    debugger (1.6.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
+    diff-lcs (1.2.4)
+    eventmachine (0.12.10)
+    httpclient (2.3.4.1)
+    i18n (0.6.5)
+    json_pure (1.8.0)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.7.9)
+    multipart-post (1.2.0)
+    nats (0.4.28)
+      daemons (>= 1.1.5)
+      eventmachine (= 0.12.10)
+      json_pure (>= 1.7.3)
+      thin (>= 1.4.1)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-debugger (0.2.2)
+      debugger (~> 1.3)
+      pry (~> 0.9.10)
+    rack (1.5.2)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    rubyzip (0.9.9)
+    slop (3.4.6)
+    thin (1.5.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    thread_safe (0.1.2)
+      atomic
+    tzinfo (0.3.37)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (~> 1.3)
+  cf-uaa-lib
+  cfoundry_helper!
+  httpclient
+  nats
+  pry
+  pry-debugger
+  rake
+  rspec
+  yajl-ruby

data/README.textile

@@ -0,0 +1,55 @@
+h1. CFoundry Helper
+
+This collection of scripts provides helper methods to the cfoundry gem's
+API. It implements common use cases when administrating a Cloud Foundry installation.
+
+h2. Organization management
+
+The CFoundryHelper::Helpers::OrganizationHelper modules' methods provide helper methods for the following use cases:
+
+* create organizations
+* add/remove Users from organizations
+* administer User roles within organizations
+
+h2. User management
+
+The CFoundryHelper::Helpers::UserHelper module provides methods for managing users within the system:
+
+* get user by email
+* create a user 
+* delete a user
+* change a user's password
+
+h2. Space management
+
+The CFoundryHelper::Helpers::OrganizationHelper modules' methods provide helper methods for the following use cases:
+* create a space within an organization
+* add/remove Users from spaces
+* administer User roles within a space
+* empty a space (remove all apps, service_bindings, service_instances, routes and domains from the space) 
+* delete a space
+
+h2. Client Helper
+
+The CFoundryHelper::Helpers::ClientHelper is a factory for uaa and cloud controller clients.
+
+
+h2. Scripts
+
+* bin/add_users_to_org : adds users to an organization
+    ** usage : RAILS_ENV=<test / production / development> bundle exec bin/add_users_to_org <org name> <users_email_list_file_location> <services_config_file_location>
+* bin/create_space_for_org : creates a space to an organization and assigns all organization members to it
+    ** usage : RAILS_ENV=<test / production / development> bundle exec bin/create_space_for_org <org name> <space name> <services_config_file_location>
+
+h2. Important environment variables
+
+* RAILS_ENV : The helper is reading the target environment on which to execute commands using the RAILS_ENV environment variable. (e.g. production, test)
+
+* CFOUNDRY_HELPER_CONFIG This variable has to point to your services.yml file.
+
+h2. Console Usage
+
+Use the following command to start the console with the associated target: 
+RAILS_ENV=<target_env> CFOUNDRY_HELPER_CONFIG=<services config file> rake c
+
+e.g.: RAILS_ENV=production CFOUNDRY_HELPER_CONFIG=config/services.yml rake c

data/Rakefile

@@ -0,0 +1,24 @@
+require "bundler/gem_tasks"
+
+if ["test", "development"].include?(ENV["RAILS_ENV"])
+  require "pry"
+
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+else
+  task :default => :console
+end
+
+
+desc 'starts a interactive shell'
+task :console do
+  if ENV["RAILS_ENV"] == "production"
+    exec('irb -r ./lib/cfoundry_helper.rb')
+  else
+    exec('pry -r ./lib/cfoundry_helper.rb')
+  end
+end
+
+task c: :console

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/bin/add_users_to_org

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "cfoundry_helper"
+
+#require_relative '../lib/cfoundry_helper'
+
+# function definitions ---------------------------------------------
+def print_help
+  puts "You have entered a wrong number of arguments!"
+  puts "Usage: add_users_to_org <organization name> <user list file location> <config file path>"
+end
+
+def add_user_to_org(org, email)
+  user = CFoundryHelper::Helpers::UserHelper.get_user_by_email email
+  CFoundryHelper::Helpers::OrganizationHelper.add_user org, user
+  CFoundryHelper::Helpers::OrganizationHelper.add_roles org, user,
+    [CFoundryHelper::Models::OrganizationRole::AUDITOR, CFoundryHelper::Models::OrganizationRole::MANAGER]
+end
+
+def check_users_present(file_loc)
+  all_existing = true
+  File.open(file_loc).each do |email|
+    email = email.strip
+    puts "Checking email=#{email} ...."
+    unless CFoundryHelper::Helpers::UserHelper.email_exists? email
+      puts "The user email=#{email} doesn't exist in the system!"
+      all_existing = false
+    end
+  end
+  if all_existing
+    puts "All emails are present in the system!"
+  else
+    puts "Some emails are not present in the system!"
+  end
+  all_existing
+end
+
+def add_users(org_name, file_loc)
+  org = CFoundryHelper::Helpers::OrganizationHelper.get_organization_by_name org_name
+  if org.nil?
+    puts "No organization with the name=#{org_name} could be found!"
+    exit(-1)
+  end
+  puts "Adding users to the #{org_name} organization!"
+
+  File.open(file_loc).each do |email|
+    email = email.strip
+    puts "Adding user with email=#{email}"
+    add_user_to_org org, email
+  end
+
+  puts "Finished adding users!"
+end
+
+def print_rails_env
+  puts "RAILS_ENV=#{ENV["RAILS_ENV"]}"
+end
+
+# execute script ----------------------------------------------
+
+if ARGV.count < 3
+  print_help
+  exit(-1)
+end
+
+puts "add users to organization"
+print_rails_env
+
+organization_name = ARGV[0]
+file_loc = ARGV[1]
+config_file_path = ARGV[2]
+
+CFoundryHelper::Helpers::ClientHelper.set_config_file_path config_file_path
+
+puts "Organization: #{organization_name}"
+puts "Cloud Controller target url: #{CFoundryHelper::Helpers::ClientHelper.get_cc_target_url}"
+
+unless check_users_present(file_loc)
+  puts "Canceling operation!"
+  exit(-1)
+end
+
+add_users(organization_name, file_loc)
+
+
+
+
+
+
+
+
+
+

data/bin/create_space_for_org

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "cfoundry_helper"
+
+# function definitions ---------------------------------------------
+def print_help
+  puts "This script adds a new space with the given name to the organization with the given name."
+  puts "If the given space already exists, it just assigns the roles to the organization's users."
+  puts "Members of the given organization are registered as Space Developers and Space Auditors."
+  puts "You have entered a wrong number of arguments!"
+  puts "Usage: create_spaces_for_org <organization name> <space name> <config file path>"
+end
+
+def print_rails_env
+  puts "RAILS_ENV=#{ENV["RAILS_ENV"]}"
+end
+
+def get_org(org_name)
+  org = CFoundryHelper::Helpers::OrganizationHelper.get_organization_by_name org_name
+  if org.nil?
+    print "No organization with the given name could be found!"
+    exit -1
+  end
+  org
+end
+
+def create_or_get_space(org, space_name)
+  puts "Creating space with name=#{space_name} ..."
+  space = nil
+  begin
+    space = CFoundryHelper::Helpers::SpaceHelper.create_space org, space_name
+    puts "Created space successfully!"
+  rescue
+    puts "The space #{space_name} already exists."
+    puts "Using this space to assign user roles now."
+    space = CFoundryHelper::Helpers::SpaceHelper.get_space org, space_name
+  end
+  space
+end
+
+def set_user_roles(space, user)
+  CFoundryHelper::Helpers::SpaceHelper.add_roles space, user,
+                                                 [CFoundryHelper::Models::SpaceRole::AUDITOR,
+                                                  CFoundryHelper::Models::SpaceRole::DEVELOPER]
+end
+
+def set_org_users_space_roles(org, space)
+  puts "Setting roles for organization users..."
+  org.users.each do |u|
+    puts "Setting roles for user with guid=#{u.guid} ...."
+    set_user_roles space, u
+  end
+  puts "Finished setting roles!"
+end
+
+# execute script ----------------------------------------------
+
+if ARGV.count < 3
+  print_help
+  exit(-1)
+end
+
+puts "create space for organization"
+print_rails_env
+
+organization_name = ARGV[0]
+space_name = ARGV[1]
+config_file_path = ARGV[2]
+
+CFoundryHelper::Helpers::ClientHelper.set_config_file_path config_file_path
+
+puts "Organization: #{organization_name}"
+puts "Space name: #{space_name}"
+puts "Cloud Controller target url: #{CFoundryHelper::Helpers::ClientHelper.get_cc_target_url}"
+
+org = get_org organization_name
+space = create_or_get_space org, space_name
+set_org_users_space_roles org, space

data/bin/delete_orgs_and_users

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "cfoundry_helper"
+
+# function definitions ---------------------------------------------
+def print_help
+  puts "This script delete a list of users including their default organization."
+  puts "You have entered a wrong number of arguments!"
+  puts "Usage: delete_orgs_and_users <user list file path> <config file path>"
+end
+
+def print_rails_env
+  puts "RAILS_ENV=#{ENV["RAILS_ENV"]}"
+end
+
+def get_standard_org_name_for_email(email)
+  email.gsub(/[\.|@]/, "_")
+end
+
+def delete_user(email)
+  begin
+    user = CFoundryHelper::Helpers::UserHelper.get_user_by_email email
+  rescue
+    puts "Could not find user with email=#{email}"
+    return
+  end
+
+  puts "Deleting user with email=#{email}"
+  CFoundryHelper::Helpers::UserHelper.delete_user user
+end
+
+def delete_org(org_name)
+  org = CFoundryHelper::Helpers::OrganizationHelper.get_organization_by_name org_name
+  if org.nil?
+    puts "Could not find organization with name=#{org_name}"
+    return
+  end
+
+  puts "Deleting organization with name=#{org_name}"
+  CFoundryHelper::Helpers::OrganizationHelper.delete_organization_recursive org
+end
+
+
+def delete_users(file_loc)
+  File.open(file_loc).each do |email|
+    email = email.strip
+    delete_user email
+    delete_org get_standard_org_name_for_email(email)
+  end
+
+  puts "Finished deleting users!"
+end
+
+
+# execute script ----------------------------------------------
+
+if ARGV.count < 2
+  print_help
+  exit(-1)
+end
+
+file_loc = ARGV[0]
+config_file_path = ARGV[1]
+
+print_rails_env
+puts "removing users and organizations described in #{file_loc}"
+
+CFoundryHelper::Helpers::ClientHelper.set_config_file_path config_file_path
+
+puts "Cloud Controller target url: #{CFoundryHelper::Helpers::ClientHelper.get_cc_target_url}"
+
+delete_users file_loc