openshift-origin-controller 1.3.2

data/test/cucumber/rest-quickstarts.feature

@@ -0,0 +1,27 @@
+@broker_api
+@broker_api1
+Feature: quickstarts
+  As an API client
+  In order to do things with quickstarts
+  I want to List and Show quickstarts without authenticating
+
+  Scenario: List quickstarts
+    Given I accept "JSON"
+    When I send an unauthenticated GET request to "/quickstarts"
+    Then the response should be "200"
+    And the response should be a list of "quickstarts"
+    
+  Scenario: Get a specific quickstart
+    Given I accept "JSON"
+    And a quickstart UUID
+    When I send an unauthenticated GET request to "/quickstarts/<uuid>"
+    Then the response should be "200"
+    And the response should be a "quickstart"
+    
+  Scenario: Get community quickstart URLs
+    Given I accept "JSON"
+    #And the Rails openshift configuration key community_base_url is "/community/"
+    When I send an unauthenticated GET request to "/api"
+    Then the response should be "200"
+    And the response should have the links "LIST_QUICKSTARTS, SHOW_QUICKSTART"
+

data/test/cucumber/rest-workflow.feature

@@ -0,0 +1,64 @@
+@broker
+Feature: Rest Quick tests
+  As an developer I want to make sure I didn't break anything that is going to prevent others from working
+    
+  Scenario Outline: Typical Workflow
+    Given a new user
+    And I accept "<format>"
+    When I send a POST request to "/user/keys" with the following:"name=api&type=ssh-rsa&content=XYZ123567"
+    Then the response should be "201"
+    And the response should be a "key" with attributes "name=api&type=ssh-rsa&content=XYZ123567"
+    When I send a GET request to "/user/keys/api"
+    Then the response should be "200"
+    And the response should be a "key" with attributes "name=api&type=ssh-rsa&content=XYZ123567"
+    When I send a POST request to "/domains" with the following:"id=api<random>"
+    Then the response should be "201"
+    When I send a POST request to "/domains/api<random>/applications" with the following:"name=app&cartridge=php-5.3"
+    Then the response should be "201"
+    And the response should be a "application" with attributes "name=app&framework=php-5.3"
+    When I send a GET request to "/domains/api<random>/applications/app"
+    Then the response should be "200"
+    And the response should be a "application" with attributes "name=app&framework=php-5.3"
+    When I send a GET request to "/domains/api<random>/applications"
+    Then the response should be "200"
+    When I send a POST request to "/domains/api<random>/applications/app/events" with the following:"event=stop"
+    Then the response should be "200"
+    When I send a POST request to "/domains/api<random>/applications/app/events" with the following:"event=start"
+    Then the response should be "200"
+    When I send a POST request to "/domains/api<random>/applications/app/events" with the following:"event=start"
+    Then the response should be "200"
+    When I send a POST request to "/domains/api<random>/applications/app/events" with the following:"event=force-stop"
+    Then the response should be "200"
+    When I send a POST request to "/domains/api<random>/applications/app/events" with the following:"event=add-alias&alias=app-api.foobar.com"
+    Then the response should be "200"
+    When I send a POST request to "/domains/api<random>/applications/app/events" with the following:"event=remove-alias&alias=app-api.foobar.com"
+    Then the response should be "200"
+    When I send a POST request to "/domains/api<random>/applications/app/cartridges" with the following:"cartridge=mysql-5.1"
+    Then the response should be "201"
+    When I send a GET request to "/domains/api<random>/applications/app/descriptor"
+    Then the response descriptor should have "php-5.3,mysql-5.1" as dependencies
+    When I send a POST request to "/domains/api<random>/applications/app/cartridges/mysql-5.1/events" with the following:"event=stop"
+    Then the response should be "200"
+    When I send a POST request to "/domains/api<random>/applications/app/cartridges/mysql-5.1/events" with the following:"event=start"
+    Then the response should be "200"
+    When I send a POST request to "/domains/api<random>/applications/app/cartridges/mysql-5.1/events" with the following:"event=restart"
+    Then the response should be "200"
+    When I send a DELETE request to "/domains/api<random>/applications/app/cartridges/mysql-5.1"
+    Then the response should be "200"
+    When I send a PUT request to "/domains/api<random>" with the following:"id=apiX<random>"
+    Then the response should be "200"
+    And the response should be a "domain" with attributes "id=apiX<random>"
+    When I send a DELETE request to "/domains/apiX<random>/applications/app"
+    Then the response should be "204"
+    When I send a GET request to "/domains/apiX<random>/applications/app"
+    Then the response should be "404"
+    When I send a DELETE request to "/domains/apiX<random>"
+    Then the response should be "204"
+    When I send a DELETE request to "/user/keys/api"
+    Then the response should be "204"
+    
+    Scenarios:
+     | format | 
+     | JSON | 
+     | XML | 
+

data/test/cucumber/step_definitions/api_steps.rb

@@ -0,0 +1,369 @@
+require 'rubygems'
+require 'rest_client'
+require 'nokogiri'
+#require '/var/www/openshift/broker/config/environment'
+require 'logger'
+
+@random = nil
+Before do
+  @base_url = "https://localhost/broker/rest"
+end
+
+After do |scenario|
+  domains = ["api#{@random}", "apiX#{@random}", "apiY#{@random}", "app-api#{@random}"]
+  remove_dns_entries(domains)
+  @random = nil
+  (@undo_config || []).each do |(main, secondary, value)|
+    Rails.configuration[main.to_sym][secondary.to_sym] = value
+  end
+end
+
+Given /^a new user$/ do
+  @random = rand(99999999)
+  @username = "rest-test-#{@random}"
+  @password = "xyz123"
+  
+  register_user(@username, @password) if $registration_required
+
+#TODO authenticate user
+
+end
+
+Given /^the Rails ([^\s]+) configuration key ([^\s]+) is "([^\"]*)"$/ do |main, secondary, value|
+  (@undo_config ||= []) << [main, secondary, Rails.configuration.config[main.to_sym][secondary.to_sym]]
+  Rails.configuration.config[main.to_sym][secondary.to_sym] = value
+end
+
+Given /^I send and accept "([^\"]*)"$/ do |type|
+  @headers = {:accept => type, :content_type => type}
+end
+
+Given /^I accept "([^\"]*)"$/ do |type|
+  @accept_type = type
+  @headers = {:accept => type.to_s.downcase}
+end
+
+Given /^an application template UUID$/ do
+  path = sub_random('/application_templates')
+  url = @base_url + path.to_s
+  @request = RestClient::Request.new(:method => :get, :url => url, :headers => @headers)
+  begin
+    @response = @request.execute()
+  rescue => e
+    @response = e.response
+  end
+  
+  # Get a normalized list of templates
+  application_templates = unpacked_data(@response.body)
+
+  @uuid = application_templates[0]['uuid']
+end
+
+Given /^a quickstart UUID$/ do
+  path = sub_random('/quickstarts')
+  url = @base_url + path.to_s
+  @request = RestClient::Request.new(:method => :get, :url => url, :headers => @headers)
+  begin
+    @response = @request.execute()
+  rescue => e
+    @response = e.response
+  end
+
+  # Get a normalized list of quickstarts
+  quickstarts = unpacked_data(@response.body)
+
+  @uuid = quickstarts[0]['quickstart']['id']
+end
+
+When /^I send a GET request to "([^\"]*)"$/ do |path|
+  path = sub_random(path)
+  url = @base_url + path.to_s
+  @request = RestClient::Request.new(:method => :get, :url => url,
+  :user => @username, :password => @password, :headers => @headers)
+  begin
+    @response = @request.execute()
+  rescue => e
+  @response = e.response
+  end
+end
+
+When /^I send an unauthenticated GET request to "([^\"]*)"$/ do |path|
+  path = sub_random(sub_uuid(path))
+  url = @base_url + path.to_s
+  @request = RestClient::Request.new(:method => :get, :url => url, :headers => @headers)
+  begin
+    @response = @request.execute()
+  rescue => e
+  @response = e.response
+  end
+end
+
+When /^I send a POST request to "([^\"]*)" with the following:"([^\"]*)"$/ do |path, body|
+  path = sub_random(path)
+  body = sub_random(body)
+  #puts "path #{path}"
+  #puts "body #{body}"
+  payload = {}
+  params = body.split("&")
+  params.each do |param|
+    key, value = param.split("=", 2)
+    if payload[key].nil?
+       payload[key] = value
+    else
+      values = [payload[key], value]
+      payload[key] = values.flatten
+    end
+  end
+  url = @base_url + path.to_s
+  @request = RestClient::Request.new(:method => :post, :url => url,
+  :user => @username, :password => @password, :headers => @headers,
+  :payload => payload)
+  begin
+    @response = @request.execute()
+  rescue => e
+  @response = e.response
+  end
+end
+
+When /^I send a PUT request to "([^\"]*)" with the following:"([^\"]*)"$/ do |path, body|
+  path = sub_random(path)
+  body = sub_random(body)
+  #puts "path #{path}"
+  #puts "body #{body}"
+  payload = {}
+  params = body.split("&")
+  params.each do |param|
+    key, value = param.split("=", 2)
+    payload[key] = value
+  end
+  url = @base_url + path.to_s
+  @request = RestClient::Request.new(:method => :put, :url => url,
+  :user => @username, :password => @password, :headers => @headers,
+  :payload => payload)
+  begin
+    @response = @request.execute()
+  rescue => e
+  @response = e.response
+  end
+end
+
+When /^I send a DELETE request to "([^\"]*)"$/ do |path|
+  path = sub_random(path)
+  #puts "path #{path}"
+
+  url = @base_url + path.to_s
+  @request = RestClient::Request.new(:method => :delete, :url => url,
+  :user => @username, :password => @password, :headers => @headers)
+  begin
+    @response = @request.execute()
+  rescue => e
+  @response = e.response
+  end
+end
+
+Then /^the response should be "([^\"]*)"$/ do |status|
+  puts "#{@response.body}"  if @response.code != status.to_i
+  @response.code.should == status.to_i
+end
+
+Then /^the response should have the link(?:s)? "([^\"]*)"$/ do |link|
+  response_acceptable = false
+  link_names = link.split(",")
+  missing_names = link_names.select do |name|
+    if link = links[name.strip]
+      URI.parse(link['href'])
+      !link['method'] || !link['rel'] || !link['required_params']
+    else
+      true
+    end
+  end
+  raise "Response did not contain link(s) #{missing_names.join(", ")}" unless missing_names.empty?
+  true
+end
+
+Then /^the response should be one of "([^\"]*)"$/ do |acceptable_statuses|
+  response_acceptable = false
+  statuses = acceptable_statuses.split(",")
+  statuses.each do | status|
+    puts "#{@response.body}"  if @response.code != status.to_i
+    response_acceptable = true unless @response.code != status.to_i
+  end
+  response_acceptable.should == true
+end
+
+Then /^the response should be a "([^\"]*)" with attributes "([^\"]*)"$/ do |tag, attributes_str|
+  attributes_str = sub_random(attributes_str)
+  attributes_array = attributes_str.split("&")
+  if @accept_type.upcase == "XML"
+    #puts @response.body
+    result = Nokogiri::XML(@response.body)
+    attributes_array.each do |attributes|
+      key, value = attributes.split("=", 2)
+      #puts "#{result.xpath("//#{tag}/#{key}").text} #{value}"
+      result.xpath("//#{tag}/#{key}").text.should == value
+    end
+  elsif @accept_type.upcase == "JSON"
+    result = JSON.parse(@response.body)
+    obj = result["data"]
+    attributes_array.each do |attributes|
+      key, value = attributes.split("=", 2)
+      obj[key].should == value
+    end
+  else
+  false
+  end
+end
+
+Then /^the response should be a list of "([^\"]*)" with attributes "([^\"]*)"$/ do |tag, attributes_str|
+  attributes_str = sub_random(attributes_str)
+  attributes_array = attributes_str.split("&")
+  if @accept_type.upcase == "XML"
+    #puts @response.body
+    result = Nokogiri::XML(@response.body)
+    attributes_array.each do |attributes|
+      key, value = attributes.split("=", 2)
+      #puts "#{result.xpath("//#{tag}/#{key}").text} #{value}"
+      result.xpath("//#{tag}/#{key}").text.should == value
+    end
+  elsif @accept_type.upcase == "JSON"
+    result = JSON.parse(@response.body)
+    obj = result["data"]
+    attributes_array.each do |attributes|
+      key, value = attributes.split("=", 2)
+      obj[key].should == value
+    end
+  else
+  false
+  end
+end
+
+Then /^the error message should have "([^\"]*)"$/ do |attributes_str|
+  attributes_str = sub_random(attributes_str)
+  attributes_array = attributes_str.split("&")
+  if @accept_type.upcase == "XML"
+    #puts @response.body
+    result = Nokogiri::XML(@response.body)
+    messages = result.xpath("//message")
+    #puts messages
+    attributes_array.each do |attributes|
+      key, value = attributes.split("=", 2)
+      key = key.sub("_", "-")
+      messages.each do |message|
+        #puts message
+        #puts message.xpath("#{key}").text
+        message.xpath("#{key}").text.should == value
+      end
+    end
+  elsif @accept_type.upcase == "JSON"
+    result = JSON.parse(@response.body)
+    messages = result["messages"]
+    attributes_array.each do |attributes|
+      key, value = attributes.split("=", 2)
+      messages.each do |message|
+        message[key].to_s.should == value
+      end
+    end
+  else
+  false
+  end
+end
+
+Then /^the response descriptor should have "([^\"]*)" as dependencies$/ do |deps|
+  #puts @response.body
+  if @accept_type.upcase == "XML"
+    page = Nokogiri::XML(@response.body)
+    desc_yaml = page.xpath("//response/data/datum")
+    desc = YAML.load(desc_yaml.text.to_s)
+  elsif @accept_type.upcase == "JSON"
+    page = JSON.parse(@response.body)
+    desc_yaml = page["data"]
+    desc = YAML.load(desc_yaml)
+  end
+  #desc = YAML.load(desc_yaml.text.to_s)
+  deps.split(",").each do |dep|
+    desc["Requires"].should include(dep)
+  end
+end
+
+Then /^the response should be a list of "([^\"]*)"$/ do |list_type|
+  items = unpacked_data(@response.body)
+  if items.length < 1 && list_type != 'application templates' 
+    raise("I got an empty list of #{list_type}")
+  end
+  if list_type == 'cartridges'
+    items.each do |cartridge|
+      check_cartridge(cartridge)
+    end
+  elsif list_type == 'application templates'
+    items.each do |application_template|
+      check_application_template(application_template)
+    end
+  elsif list_type == 'quickstarts'
+    items.each do |item|
+      check_quickstart(item)
+    end
+  else
+    raise("I don't recognize list type #{list_type}")
+  end
+end
+
+Then /^the response should be a "([^\"]*)"$/ do |item_type|
+  item = unpacked_data(@response.body)[0]
+  if item_type == 'cartridge'
+    check_cartridge(item)
+  elsif item_type == 'application template'
+    check_application_template(item)
+  elsif item_type == 'quickstart'
+    check_quickstart(item)
+  else
+    raise("I don't recognize item type #{item_type}")
+  end
+end
+
+def check_cartridge(cartridge)
+  unless cartridge.has_key?("name") && cartridge['name'].match(/\S+/)
+    raise("I found a cartridge without a name")
+  end
+end
+
+def check_application_template(application_template)
+  unless application_template.has_key?("uuid") && application_template['uuid'].match(/\S+/)
+    raise("I found an application without a UUID")
+  end
+end
+
+def check_quickstart(quickstart)
+  unless quickstart.has_key?("quickstart") && quickstart['quickstart'].has_key?("id") && quickstart['quickstart']['id'].match(/\S+/)
+    raise("I found a quickstart without an ID")
+  end
+end
+
+# Gets a normalized response
+def unpacked_data(response_body)
+  if @accept_type.upcase == 'JSON'
+    data = JSON.parse(@response.body)['data']
+  elsif @accept_type.upcase == 'XML'
+    data = Hash.from_xml(@response.body)['response']['data']['template']
+  end
+  return data.is_a?(Array) ? data : [data]
+end
+
+def sub_random(value)
+  if value and value.include? "<random>"
+    value = value.sub("<random>", @random.to_s)
+  end
+  return value
+end
+
+def sub_uuid(value)
+  if value and value.include? "<uuid>"
+    value = value.sub("<uuid>", @uuid)
+  end
+  return value
+end
+
+def links
+  @links ||= if @accept_type.upcase == "JSON"
+      result = JSON.parse(@response.body)['data']
+    end
+end