test_rail-api 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46276f27c1fc6c5bb81ad20d5b6f32fa83898dfb
-  data.tar.gz: 48849b393aadc4e1e2774bcef2b1f56b8455a81a
+  metadata.gz: 4196384451523f5e9c7da96179d59e6999e28058
+  data.tar.gz: 90eade64f69d32450158006537e85c2ffeab999d
 SHA512:
-  metadata.gz: 869cf0734b672613ddbc0ae5d803cc8630a1971fff0c03c40a2256f3a531600f2e95f17f4905cb06f3cfb79fdc20366c90256bcddc2f437a39e1d86d26e6293c
-  data.tar.gz: 788cc15eeaf18360eb8a5e319065853a2ed85da6c5490402c3581195da109021e3dfc59dd7c4fc07dec459a181588ced7754dff522c6e32a66e7f2519d7a10ab
+  metadata.gz: 76c104fae09342eef31e96e0bb1d6a941fed07352eb5b0b898478d2ac5e7a2d984928c0fc85d3de68032a17f8878659a9396efd4144325eb39206c5bc882c601
+  data.tar.gz: f41459a4157ea7c91d6af3569cbebbd04b826fa8c9fa45fc65d74ecfce47a751daec9ad25908ad7004d653e3a1668dd8e8cc8a77c47ece3b479e32ae895e854b

data/lib/test_rail/api.rb

@@ -65,6 +65,53 @@ module TestRail
       return projectexists
     end
 
+    #
+    # Plan API calls
+    #
+
+    # Add a new plan
+    # (If plan already exists, a new one is created with the same name)
+    # api.add_plan( :project_id => 1, :name => 'My new Plan', :description => 'Test Plan' )
+    # Returns the plan object
+    def add_plan(args)
+      project_id = args[:project_id] or raise 'Missing project id (:project_id => 1)'
+      name = args[:name] or raise 'Missing plan name (:name => "My Test Plan")'
+      description = args[:description]
+
+      plan = post('add_plan', [project_id], { :name => name, :description => description })
+      TestRail::Plan.new(plan.merge({ :api => self }))
+    end
+
+    # Get a list of plans for a project
+    # api.get_plans( :project_id => 1 )
+    # Returns a list of plan objects
+    def get_plans(args)
+      id = args[:project_id] or raise "Missing project id (:project_id => 1)"
+      list = get('get_plans', [id])
+      list.collect do |item|
+        TestRail::Plan.new(item.merge({ :api => self }))
+      end
+    end
+
+    # Given a plan id, returns a plan (and populates internal run objects)
+    def get_plan(args)
+      plan_id = args[:plan_id] or raise "Missing plan id (:plan_id => 1)"
+      result = get('get_plan', [plan_id])
+      raw_runs = result['entries'].collect { |e| e['runs'] }.flatten
+      runs     = raw_runs.each.collect { |r| TestRail::Run.new(r.merge({ :api => self })) }
+      plan = TestRail::Plan.new(result.merge({ :api => self, :runs => runs }))
+      plan
+    end
+ 
+    def update_plan(args)
+      id = args[:id] or raise "Missing plan id (:id => 1)"
+      name        = args[:name]
+      description = args[:description]
+
+      plan = post('update_plan', [id], { :name => name, :description => description })
+      TestRail::Plan.new(plan.merge({ :api => self }))
+    end
+
     #
     # Suite API calls
     #
@@ -243,18 +290,21 @@ module TestRail
       TestRail::Run.new(result.merge({ :api => self }))
     end
 
-    # Given a plan id, returns a plan (and populates internal run objects)
-    def get_plan(args)
-      plan_id = args[:plan_id] or raise "Missing plan id (:plan_id => 1)"
-
-      result = get('get_plan', [plan_id])
-
-      raw_runs = result['entries'].collect { |e| e['runs'] }.flatten
-      runs     = raw_runs.each.collect { |r| TestRail::Run.new(r.merge({ :api => self })) }
-
-      plan = TestRail::Plan.new(result.merge({ :api => self, :runs => runs }))
+    # Add a new run in test plan
+    # api.add_run_in_plan( :project_id => project_id, :plan_id => plan_id, :suite_id => suite_id )
+    def add_run_in_plan(args)
+      project_id = args[:project_id] or raise "Missing project id ( :project_id => 1)"
+      plan_id = args[:plan_id] or raise "Missing project id ( :project_id => 1)"
+      suite_id = args[:suite_id] or raise "Missing suite id ( :suite_id => 1)"
 
-      plan
+      params = { 
+                 :project_id => project_id,
+                 :suite_id => suite_id,
+                 :name     => args[:name],
+                 :description => args[:description] 
+               }
+      result = post('add_plan_entry', [plan_id], params)["runs"][0]
+      TestRail::Run.new(result.merge({ :api => self }))
     end
 
     def get_tests(args)

data/lib/test_rail/project.rb

@@ -16,6 +16,12 @@ module TestRail
       @api.get_suites( :project_id => @id )
     end
 
+    # Return a list of plans belonging to this project
+    def plans
+      @api.get_plans( :project_id => @id )
+    end
+
+
     # Create a new suite for this project
     def new_suite( args )
       @api.add_suite( args.merge({:project_id => id}) )
@@ -28,6 +34,19 @@ module TestRail
       suites.select{ |s| s.name == name }.first
     end
 
+    # Create a new plan for this project
+    def new_plan( args )
+      @api.add_plan( args.merge({:project_id => id}) )
+    end
+
+    # Find a plan in this project based on the plan name
+    # project.find_plan( :name => "My Plan" )
+    def find_plan( args )
+      name = args[:name] or raise "Need to provide the name of plan"
+      plans.select{ |s| s.name == name }.first
+    end
+
+
     # Find or create a suite in this project based on the suite name
     # project.find_or_create_suite( :name => "My Suite" )
     def find_or_create_suite( args )
@@ -38,5 +57,15 @@ module TestRail
       end
       suite
     end
+
+    def find_or_create_plan( args )
+      name =args[:name] or raise "Need to provide name of plan"
+      plan = self.find_plan( args )
+      if plan.nil?
+        plan = new_plan( args )
+      end
+      plan
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test_rail-api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - BBC
@@ -108,9 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Test Rail API
 test_files: []
-has_rdoc: