rtrail 0.0.1

data/spec/api_spec.rb

@@ -0,0 +1,46 @@
+require_relative 'spec_helper'
+
+module RTrail
+  describe API do
+    let(:api) { API.new("http://localhost:8080/", "user", "password") }
+
+    describe "#initialize" do
+      it "initializes the client" do
+        expect(api.client).to_not be_nil
+      end
+    end
+
+    describe "#projects" do
+      it "returns all Projects" do
+        projects = api.projects
+        expect(projects).to be_an(Array)
+        expect(projects.first).to be_a(Project)
+      end
+    end
+
+    describe "#project" do
+      it "returns a Project instance" do
+        project = api.project("First Project")
+        expect(project).to be_a(Project)
+        expect(project.name).to eq("First Project")
+      end
+    end
+
+    describe "#runs" do
+      it "returns all Runs for the given Project" do
+        runs = api.runs("First Project")
+        expect(runs).to be_an(Array)
+        expect(runs.first).to be_a(Run)
+      end
+    end
+
+    describe "#cases" do
+      it "returns all Cases for the given Project and Suite" do
+        cases = api.cases("First Project", "First Suite")
+        expect(cases).to be_an(Array)
+        expect(cases.first).to be_a(Case)
+      end
+    end
+  end
+end # module RTrail
+

data/spec/case_spec.rb

@@ -0,0 +1,12 @@
+require_relative 'spec_helper'
+
+module RTrail
+  describe Case do
+    context "Class methods" do
+    end
+
+    context "Instance methods" do
+    end
+  end
+end # module RTrail
+

data/spec/client_spec.rb

@@ -0,0 +1,43 @@
+require_relative 'spec_helper'
+
+module RTrail
+  describe Client do
+    let(:base_url) { MOCK_APP_URL }
+    let(:user) { "somebody" }
+    let(:password) { "pa$$w0rd1" }
+    let(:client) { Client.new(base_url, user, password) }
+
+    describe "#initialize" do
+      it "sets base_url, user, and password attributes" do
+        expect(client.base_url).to eq(base_url)
+        expect(client.user).to eq(user)
+        expect(client.password).to eq(password)
+      end
+    end
+
+    describe "#get" do
+      it "sends a GET request" do
+        expect(client).to receive(:_request).with(:get, 'get_project/1')
+        client.get("get_project/1")
+      end
+
+      it "raises RTrail::Error when GET object is not found" do
+        expect {
+          client.get("get_project/999")
+        }.to raise_error(RTrail::Error)
+      end
+    end
+
+    describe "#post" do
+      it "sends a POST request" do
+        fields = {
+          :suite_id => 1,
+          :name => "Test Run",
+        }
+        expect(client).to receive(:_request).with(:post, 'add_run/1', fields)
+        client.post("add_run/1", fields)
+      end
+    end
+  end
+end # module RTrail
+

data/spec/entity_spec.rb

@@ -0,0 +1,12 @@
+require_relative 'spec_helper'
+
+module RTrail
+  describe Entity do
+    context "Class methods" do
+    end
+
+    context "Instance methods" do
+    end
+  end
+end # module RTrail
+

data/spec/helpers_spec.rb

@@ -0,0 +1,52 @@
+require_relative 'spec_helper'
+require 'hashie'
+
+module RTrail
+  describe Helpers do
+    class Thing < Hashie::Mash
+      include RTrail::Helpers
+    end
+
+    let(:thing) { Thing.new }
+
+    describe "#is_id?" do
+      it "returns true for numeric strings" do
+        expect(thing.is_id?('0')).to be true
+        expect(thing.is_id?('4')).to be true
+        expect(thing.is_id?('117')).to be true
+        expect(thing.is_id?('62521')).to be true
+      end
+
+      it "returns false for non-numeric strings" do
+        expect(thing.is_id?('')).to be false
+        expect(thing.is_id?('x')).to be false
+        expect(thing.is_id?('Foobar')).to be false
+        expect(thing.is_id?('This sentence no verb')).to be false
+      end
+    end
+
+    describe "#path_with_params" do
+      it "appends params to the path using TestRail's GET syntax" do
+        result = thing.path_with_params("/add_run/1", :suite_id => 4)
+        expect(result).to eq("/add_run/1&suite_id=4")
+      end
+    end
+
+    describe Helpers::HasCreateTime do
+      class Thing < Hashie::Mash
+        include RTrail::Helpers::HasCreateTime
+      end
+
+      let(:now) { Time.utc(2014, 'may', 19, 3, 45, 0) }
+      let(:thing) { Thing.new(:created_on => now.to_i) }
+
+      describe "#create_time" do
+        it "returns the `created_on` attribute as a Time" do
+          expect(thing.create_time).to be_a(Time)
+          expect(thing.create_time).to eq(now)
+        end
+      end
+    end
+  end
+end # module RTrail
+

data/spec/plan_spec.rb

@@ -0,0 +1,12 @@
+require_relative 'spec_helper'
+
+module RTrail
+  describe Plan do
+    context "Class methods" do
+    end
+
+    context "Instance methods" do
+    end
+  end
+end # module RTrail
+

data/spec/project_spec.rb

@@ -0,0 +1,132 @@
+require_relative 'spec_helper'
+
+module RTrail
+  describe Project do
+    context "Class methods" do
+      describe "#all" do
+        it "returns all Projects" do
+          projects = Project.all
+          expect(projects).to be_an(Array)
+          expect(projects.first).to be_a(Project)
+        end
+      end
+
+      describe "#by_name" do
+        it "returns the Project with the given name if it exists" do
+          project = Project.by_name("First Project")
+          expect(project).to be_a(Project)
+          expect(project).to_not be_nil
+          expect(project.name).to eq("First Project")
+        end
+
+        it "raises RTrail::NotFound if no project exists with the given name" do
+          expect {
+            Project.by_name("Bogus Project Name")
+          }.to raise_error(RTrail::NotFound, /not found in TestRail/)
+        end
+      end
+    end
+
+    context "Instance methods" do
+      let(:project1) { Project.new(1) }
+      let(:project2) { Project.new(2) }
+
+      describe "#initialize" do
+        it "gets the Project data" do
+          expect(project1.id).to eq(1)
+          expect(project1.name).to eq("First Project")
+          expect(project2.id).to eq(2)
+          expect(project2.name).to eq("Second Project")
+        end
+      end
+
+      describe "#suite_by_name" do
+        it "gets the Suite with the given name if it exists" do
+          suite = project1.suite_by_name("First Suite")
+          expect(suite).to be_a(Suite)
+          expect(suite.name).to eq("First Suite")
+        end
+
+        it "raises RTrail::NotFound if no suite exists with the given name" do
+          expect {
+            project1.suite_by_name("Third Suite")
+          }.to raise_error(RTrail::NotFound, /not found in project/)
+          expect {
+            project2.suite_by_name("First Suite")
+          }.to raise_error(RTrail::NotFound, /not found in project/)
+        end
+      end
+
+      describe "#suite" do
+        it "returns a Suite by id" do
+          suite = project1.suite(1)
+          expect(suite).to be_a(Suite)
+          expect(suite.id).to eq(1)
+          expect(suite.name).to eq("First Suite")
+        end
+
+        it "returns a Suite by name" do
+          suite = project1.suite("First Suite")
+          expect(suite).to be_a(Suite)
+          expect(suite.id).to eq(1)
+          expect(suite.name).to eq("First Suite")
+        end
+      end
+
+      describe "#suite_id" do
+        it "returns the id for a Suite" do
+          suite_id = project1.suite_id("First Suite")
+          expect(suite_id).to eq(1)
+        end
+      end
+
+      describe "#plans" do
+        it "returns all Plans in the Project" do
+          plans = project1.plans
+          expect(plans).to be_an(Array)
+          expect(plans.count).to eq(1)
+          expect(plans.first).to be_a(Plan)
+        end
+      end
+
+      describe "#runs" do
+        it "returns all Runs in the Project" do
+          runs = project1.runs
+          expect(runs.count).to eq(2)
+        end
+      end
+
+      describe "#suites" do
+        it "returns all Suites in the project" do
+          suites = project1.suites
+          expect(suites.count).to eq(2)
+        end
+      end
+
+      describe "#run" do
+        it "returns an existing Run with the same name" do
+          run = project1.run("First Suite", "First Run")
+          expect(run).to be_a(Run)
+          expect(run.id).to eq(1)
+          expect(run.suite_id).to eq(1)
+        end
+
+        it "creates a new Run and returns it" do
+          run = project1.run("First Suite", "New Run Name")
+          expect(run).to be_a(Run)
+          expect(run.suite_id).to eq(1)
+        end
+      end
+
+      describe "#add_run" do
+        it "returns the new Run" do
+          run = project1.add_run("First Suite", :name => "New Run Name")
+          expect(run).to be_a(Run)
+          expect(run.suite_id).to eq(1)
+        end
+      end
+    end
+
+  end
+end # module RTrail
+

data/spec/result_spec.rb

@@ -0,0 +1,12 @@
+require_relative 'spec_helper'
+
+module RTrail
+  describe Result do
+    context "Class methods" do
+    end
+
+    context "Instance methods" do
+    end
+  end
+end # module RTrail
+

data/spec/run_spec.rb

@@ -0,0 +1,61 @@
+require_relative 'spec_helper'
+
+module RTrail
+  describe Run do
+    context "Class methods" do
+    end
+
+    context "Instance methods" do
+      let(:run1) { Run.new(1) }
+      let(:run2) { Run.new(2) }
+
+      describe "#initialize" do
+        it "gets the Run data" do
+          expect(run1.id).to eq(1)
+          expect(run2.id).to eq(2)
+        end
+      end
+
+      describe "#summary" do
+        it "includes id and name" do
+          expect(run1.summary).to include(run1.id.to_s)
+          expect(run1.summary).to include(run1.name)
+        end
+
+        it "includes completion status" do
+          expect(run1.summary).to include("[completed")
+          expect(run2.summary).to include("[not completed")
+        end
+      end
+
+      describe "#tests" do
+        it "includes all Tests in the Run" do
+          expect(run1.tests).to be_an(Array)
+          expect(run1.tests.first).to be_a(Test)
+        end
+      end
+
+      describe "#complete_time" do
+        it "returns a Time if `completed_on` is set" do
+          expect(run1.complete_time).to be_a(Time)
+        end
+
+        it "returns nil if `completed_on` is nil" do
+          expect(run2.complete_time).to be_nil
+        end
+      end
+
+      describe "#completed?" do
+        it "returns true if `completed_on` is set" do
+          expect(run1.completed?).to be true
+        end
+
+        it "returns false if `completed_on` is nil" do
+          expect(run2.completed?).to be false
+        end
+      end
+
+    end
+  end
+end # module RTrail
+

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'simplecov'
+SimpleCov.start if ENV['COVERAGE']
+
+PROJECT_ROOT = File.expand_path('..', File.dirname(__FILE__))
+SPEC_DIR = File.join(PROJECT_ROOT, 'spec')
+MOCK_APP_URL = "http://localhost:8080/index.php?/api/v2/"
+
+$LOAD_PATH.unshift(File.join(PROJECT_ROOT, 'lib'))
+require 'rtrail'
+
+module SpecHelpers
+end
+
+RSpec.configure do |config|
+  config.include SpecHelpers
+  config.before(:all) do
+    RTrail::Entity.client = RTrail::Client.new(MOCK_APP_URL, 'user', 'password')
+  end
+end

data/spec/suite_spec.rb

@@ -0,0 +1,29 @@
+require_relative 'spec_helper'
+
+module RTrail
+  describe Suite do
+    context "Class methods" do
+    end
+
+    context "Instance methods" do
+      let(:suite) { Suite.new(1) }
+
+      describe "#sections" do
+        let(:sections) { suite.sections }
+        it "returns all Sections in the Suite" do
+          expect(sections).to be_an(Array)
+          expect(sections.first).to be_a(Section)
+        end
+      end
+
+      describe "#cases" do
+        let(:cases) { suite.cases }
+        it "returns all Cases in the Suite" do
+          expect(cases).to be_an(Array)
+          expect(cases.first).to be_a(Case)
+        end
+      end
+    end
+  end
+end # module RTrail
+

data/spec/test_spec.rb

@@ -0,0 +1,34 @@
+require_relative 'spec_helper'
+
+module RTrail
+  describe Test do
+    context "Class methods" do
+    end
+
+    context "Instance methods" do
+      let(:test) { Test.new(1) }
+
+      describe "#results" do
+        let(:results) { test.results }
+        it "returns all Results for the Test" do
+          expect(results).to be_an(Array)
+          expect(results.first).to be_a(Result)
+        end
+      end
+
+      describe "#latest_result" do
+        let(:latest_result) { test.latest_result }
+        it "returns the most recent Result for the Test" do
+          expect(latest_result).to be_a(Result)
+        end
+      end
+
+      describe "#add_result" do
+        it "returns a new Result" do
+          test.add_result(:status_id => 1)
+        end
+      end
+    end
+  end
+end # module RTrail
+