teamcity 1.3.1

data/spec/teamcity/client/builds_spec.rb

@@ -0,0 +1,113 @@
+require_relative '../../spec_helper'
+
+describe 'Builds' do
+
+  before(:each) do
+    @tc = TeamCity
+    configure_client_with_authentication
+  end
+
+  # Get requests
+  describe 'GET', :vcr do
+
+    before(:each) do
+      @buildtype_id = 'BuildTests_GetBuildTests'
+    end
+
+    describe '.builds' do
+      it 'should fetch all the builds' do
+        builds = @tc.builds
+        builds.should have_at_least(1).items
+      end
+
+      it 'should allow you to filter results by build locators' do
+        @tc.builds(count:1).should have(1).items
+      end
+
+      it 'should allow you to filter by multiple build locators' do
+        @tc.builds(count: 2, status: 'SUCCESS').should have(2).items
+      end
+
+      it 'should return an empty array if no results are found' do
+        @tc.builds(tags: 'return-empty-result').should be_empty
+      end
+    end
+
+    describe '.build' do
+      it 'should fetch the build details' do
+        build_id = @tc.builds.first.id
+        @tc.build(id: build_id).id.should eq(build_id)
+      end
+
+      it 'should raise an error if the build does not exist' do
+        expect { @tc.build(id: 'doesnotexist') }.to raise_error
+      end
+
+      it 'should raise an error if an id is not provided' do
+        expect { @tc.build }.to raise_exception(ArgumentError)
+      end
+    end
+
+    describe '.build_tags' do
+      it 'should fetch the build tags' do
+        build = @tc.builds(tags: 'tag-test').first
+        tags = @tc.build_tags(id: build.id)
+        tags.should include('tag-test')
+      end
+
+      it 'should return an empty array if there are no build tags defined for a build' do
+        build = @tc.builds.first
+        @tc.build_tags(id: build.id).should be_empty
+      end
+    end
+
+    describe '.build_pinned?', :vcr do
+      it 'should return true when a build is pinned' do
+        build_to_pin = @tc.builds.first
+        @tc.pin_build(build_to_pin.id)
+        @tc.build_pinned?(build_to_pin.id).should be_true
+      end
+
+      it 'should return false when a build is not pinned' do
+        build_to_unpin = @tc.builds.first
+        @tc.unpin_build(build_to_unpin.id)
+        @tc.build_pinned?(build_to_unpin.id).should be_false
+      end
+    end
+
+    describe '.build_statistics' do
+      it 'should return statistics for a build' do
+        build = @tc.builds.first
+        results = @tc.build_statistics(build.id)
+        results.should have_at_least(1).items
+      end
+    end
+
+    describe '.build_artifacts' do
+      it 'should fetch all the artifacts' do
+        build = @tc.builds.first
+        artifacts = @tc.build_artifacts(build.id)     
+        artifacts.should have_at_least(2).items
+      end
+    end
+  end
+
+  describe 'PUT', :vcr do
+    describe '.pin_build' do
+      it 'should pin a build' do
+        build_to_pin = @tc.builds.first
+        comment = 'this will add a comment'
+        @tc.pin_build(build_to_pin.id, comment).should be_nil
+      end
+    end
+  end
+
+  describe 'DELETE', :vcr do
+    describe '.unpin_build' do
+      it 'should unpin a build' do
+        build_to_unpin = @tc.builds.first
+        @tc.unpin_build(build_to_unpin.id).should be_nil
+      end
+    end
+  end
+end

data/spec/teamcity/client/buildtypes_spec.rb

@@ -0,0 +1,308 @@
+require_relative '../../spec_helper'
+
+describe 'BuildTypes' do
+
+  before(:each) do
+    @tc = TeamCity
+  end
+
+  after(:all) do
+    TeamCity.reset
+  end
+
+  # Get requests
+  describe 'GET', :vcr do
+
+    before(:each) do
+      TeamCity.reset
+      TeamCity.configure do |config|
+        config.endpoint = 'http://localhost:8111/guestAuth/app/rest'
+      end
+      @tc = TeamCity
+    end
+
+    describe '.buildtypes' do
+      it 'should fetch all the buildtypes' do
+        build_types = @tc.buildtypes
+        build_types.should_not be_empty
+      end
+    end
+
+    describe '.buildtype' do
+      it 'should fetch the details of a buildtype by id' do
+        build_type = @tc.buildtypes[0]
+        @tc.buildtype(id: build_type.id).id.should_not be_empty
+      end
+
+      it 'should raise an error if the buildtype does not exist' do
+        expect { @tc.buildtype(id: 'missing') }.to raise_error
+      end
+
+      it 'should raise an error if an id is not provided' do
+        expect { @tc.buildtype }.to raise_error
+      end
+    end
+
+    describe '.buildtype_branches' do
+      it 'should fetch vcs branches the vcs root is configured to use' do
+        buildtype_id = 'BuildTypeTests_GetBuildTypeConfigTests'
+        @tc.buildtype_branches(buildtype_id).first.name.should  eq('refs/heads/master')
+      end
+    end
+
+    describe '.buildtype_state' do
+      it 'should fetch the state of the buildtype' do
+        build_type = @tc.buildtypes[0]
+        @tc.buildtype_state(id: build_type.id).should eq('false')
+      end
+    end
+
+    describe '.buildtype_settings' do
+
+      before(:each) do
+        @build_type = @tc.buildtypes[0]
+      end
+
+      it 'should fetch the settings for a given buildtype' do
+        @tc.buildtype_settings(id: @build_type.id).should_not be_empty
+      end
+
+      it 'should return an array' do
+        @tc.buildtype_settings(id: @build_type.id).should be_kind_of(Array)
+      end
+    end
+
+    describe '.buildtype_template' do
+      it 'should return the attributes of the associated template' do
+        @tc.buildtype_template(id: 'BuildTypeTests_BuildTypeWithTemplate').id.should_not be_nil
+      end
+
+      it 'should return nil if the buildtype is not associated with a template' do
+        @tc.buildtype_template(id: 'BuildTypeTests_BuildTypeWithNoTemplate').should be_nil
+      end
+    end
+
+    [
+      :parameters,
+      :steps,
+      :features,
+      :triggers,
+      :agent_requirements,
+      :snapshot_dependencies,
+      :artifact_dependencies,
+      :vcs_root_entries
+    ].each do |type|
+      describe ".buildtype_#{type}" do
+
+        before(:each) do
+          @method_name = "buildtype_#{type}"
+          @buildtype_id_with_settings = 'BuildTypeTests_GetBuildTypeConfigTests'
+          @buildtype_id_with_no_settings = 'BuildTypeTests_GetBuildTypeEmptyConfigTests'
+        end
+
+        it "should fetch the build configuration #{type} for a buildtype" do
+          @tc.send(@method_name, id: @buildtype_id_with_settings).should have_at_least(1).items
+        end
+
+        it 'should return an array' do
+          @tc.send(@method_name, id: @buildtype_id_with_settings).should be_kind_of(Array)
+        end
+
+        it "should return nil if there are no #{type} defined" do
+          @tc.send(@method_name, id: @buildtype_id_with_no_settings).should be_empty
+        end
+      end
+    end
+
+    describe '.buildtype_investigations' do
+      before(:each) do
+        configure_client_with_authentication
+      end
+
+      it 'should get investigation details' do
+        @tc.buildtype_investigations('BuildTypeTests_GetBuildTypeWithInvestigations').should_not be_empty
+      end
+
+      it 'should return nil if no one is investigating' do
+        @tc.buildtype_investigations('BuildTypeTests_GetBuildTypeWithNoInvestigations').should be_empty
+      end
+    end
+  end
+
+  describe 'PUT', :vcr do
+
+    before(:all) do
+      configure_client_with_authentication
+    end
+
+    describe '.set_buildtype_parameter' do
+      it 'should set a buildtype parameter' do
+        buildtype_id = 'BuildTypeTests_PutSetBuildTypeParameters'
+        param_name = 'test-setting-buildtype-parameters'
+        param_value = 'param-value'
+        @tc.set_buildtype_parameter(buildtype_id, param_name, param_value).should eq(param_value)
+      end
+    end
+
+    describe '.set_buildtype_field' do
+      before(:each) do
+        @buildtype_id = 'BuildTypeTests_PutSetBuildTypeField'
+      end
+
+      it 'should set the buildtype name' do
+        field_name = 'name'
+        field_value = 'PutSetBuildTypeField_Name_Changed_By_Test'
+        @tc.set_buildtype_field(@buildtype_id, field_name, field_value).should eq(field_value)
+      end
+
+      it 'should set a projects description' do
+        field_name = 'description'
+        field_value = 'description-set_buildtype_field'
+        @tc.set_buildtype_field(@buildtype_id, field_name, field_value).should eq(field_value)
+      end
+
+      it 'should pause a project' do
+        field_name = 'paused'
+        field_value = 'true'
+        @tc.set_buildtype_field(@buildtype_id, field_name, field_value).should eq(field_value)
+      end
+    end
+
+    describe '.set_buildtype_setting' do
+      before(:each) do
+        @buildtype_id = 'BuildTypeTests_PutSetBuildTypeSettings'
+      end
+
+      it 'should set if it should perform clean builds' do
+        settings_name = 'cleanBuild'
+        settings_value = 'true'
+        @tc.set_buildtype_setting(@buildtype_id, settings_name, settings_value).should eq(settings_value)
+      end
+
+      it 'should set where the checkout happens when building' do
+        settings_name = 'checkoutMode'
+        settings_value = 'ON_AGENT'
+        @tc.set_buildtype_setting(@buildtype_id, settings_name, settings_value).should eq(settings_value)
+      end
+
+      it 'should set what is the timeout in minutes when executing builds' do
+        settings_name = 'executionTimeoutMin'
+        settings_value = '10'
+        @tc.set_buildtype_setting(@buildtype_id, settings_name, settings_value).should eq(settings_value)
+      end
+    end
+
+    describe '.set_build_step_field' do
+      before(:each) do
+        @buildtype_id = 'BuildTypeTests_PutSetBuildStepField'
+        @build_step_id = 'RUNNER_7'
+      end
+
+      it 'should disable a build step' do
+        field_name = 'disabled'
+        field_value = 'true'
+        @tc.set_build_step_field(@buildtype_id, @build_step_id, field_name, field_value)
+      end
+
+      it 'should enable a build step' do
+        field_name = 'disabled'
+        field_value = 'false'
+        @tc.set_build_step_field(@build_type_id, @build_step_id, field_name, field_value)
+      end
+    end
+  end
+
+  describe 'POST', :vcr do
+    before(:all) do
+      configure_client_with_authentication
+    end
+
+    before(:each) do
+      @buildtype_id = 'BuildTypeTests_PostBuildTypeTests'
+    end
+
+    describe '.create_buildtype' do
+      it 'should create a build type' do
+        project_id = 'ProjectToTestBuildTypes'
+        buildtype_name = 'PostCreateBuildType'
+        buildtype_id = "#{project_id}_#{buildtype_name}"
+        @tc.create_project(project_id)
+        response = @tc.create_buildtype(project_id, buildtype_name)
+        response.id.should eq(buildtype_id)
+      end
+    end
+
+    describe '.attach_vcs_root' do
+      it 'should attach a vcs root to a buildtype' do
+        vcs_root_id = 'teamcity_ruby_client'
+        @tc.attach_vcs_root(@buildtype_id, vcs_root_id).id.should eq(vcs_root_id)
+      end
+    end
+
+    describe '.create_agent_requirement' do
+      it 'should create an agent requirement for a buildtype' do
+        parameter_name = 'post-agent-requirement-name'
+        parameter_value = 'post-agent-requirement-value'
+        condition = 'equals'
+        args = [@buildtype_id, parameter_name, parameter_value, condition]
+        response = @tc.create_agent_requirement(*args)
+        response.id.should eq(parameter_name)
+      end
+    end
+
+    describe '.create_build_step' do
+      it 'should create a build step for a given build type' do
+        response = @tc.create_build_step(@buildtype_id, name: 'Unit Tests', type: 'Maven') do |properties|
+          properties['goals'] = 'verify'
+          properties['mavenSelection'] = 'mavenSelection:default'
+          properties['pomLocation'] = 'pom.xml'
+        end
+        response.name.should eq('Unit Tests')
+      end
+    end
+
+    describe '.create_build_trigger' do
+      it 'should create a build trigger for a given build type' do
+        response = @tc.create_build_trigger(@buildtype_id, type: 'vcsTrigger') do |properties|
+          properties['groupCheckkinsByCommitter'] = 'true'
+          properties['perCheckinTriggering'] = 'true'
+          properties['quietPeriodMode'] = 'DO_NOT_USE'
+        end
+        response.type.should eq('vcsTrigger')
+      end
+    end
+  end
+
+  describe 'DELETE', :vcr do
+    before(:all) do
+      configure_client_with_authentication
+    end
+
+    before(:each) do
+      @buildtype_id = 'BuildTypeTests_DeleteBuildTypeSettings'
+    end
+
+    describe '.delete_buildtype_parameter' do
+      it 'should delete a buildtype parameter' do
+        param_to_delete = 'delete-buildtype-param'
+        @tc.set_buildtype_parameter(@buildtype_id, param_to_delete, '')
+        @tc.delete_buildtype_parameter(@buildtype_id, 'delete-me').should be_nil
+      end
+    end
+
+    describe '.delete_agent_requirement' do
+      it 'should delete the agent requirement' do
+        agent_requirement_to_delete = 'delete-agent-requirement'
+        @tc.create_agent_requirement(@buildtype_id, agent_requirement_to_delete, '', 'equals')
+        @tc.delete_agent_requirement(@buildtype_id, agent_requirement_to_delete).should be_nil
+      end
+    end
+
+    describe '.delete_buildtype' do
+      it 'should delete a buildtype' do
+        project_id_to_delete = 'BuildTypeTests_DeleteBuildTypeRequest'
+        @tc.delete_buildtype(project_id_to_delete).should be_nil
+      end
+    end
+  end
+end

data/spec/teamcity/client/projects_spec.rb

@@ -0,0 +1,207 @@
+require_relative '../../spec_helper'
+
+describe 'Projects' do
+
+  before(:each) do
+    @tc = TeamCity
+  end
+
+  after(:all) do
+    TeamCity.reset
+  end
+
+  # GET requests
+  describe 'GET', :vcr do
+
+    before(:all) do
+      TeamCity.configure do |config|
+        config.endpoint = 'http://localhost:8111/guestAuth/app/rest'
+      end
+    end
+
+    before(:each) do
+      @tc = TeamCity
+    end
+
+    describe '.projects' do
+      it 'should fetch projects' do
+        @tc.projects.should_not be_nil
+      end
+    end
+
+    describe '.project' do
+
+      it 'should fetch a single project by id' do
+        @tc.project(id: 'GetProjectRequest').should_not be_nil
+      end
+
+      it 'should raise an error if the project does not exist' do
+        expect { @tc.project(id: 'missing') }.to raise_error
+      end
+
+      it 'should raise an error if an id is not provided' do
+        expect { @tc.project }.to raise_error
+      end
+    end
+
+
+    describe '.project_buildtypes' do
+
+      it 'should fetch all the buildTypes for a project' do
+        bts = @tc.project_buildtypes(id: 'GetProjectBuildTypes')
+        bts.each do |bt|
+          bt.projectId.should eq('GetProjectBuildTypes')
+        end
+      end
+
+      it 'should return nil if the project does not have any build types' do
+        bts = @tc.project_buildtypes(id: 'GetProjectWithNoBuildTypes')
+        bts.should be_empty
+      end
+    end
+
+    describe '.project_parameters' do
+      it 'should fetch all the paramters for a given project' do
+        parameters = @tc.project_parameters(id: 'GetProjectWithParameters')
+        parameters.size.should_not eq(0)
+      end
+
+      it 'should return nil if there are no parameters defined for a project' do
+        parameters = @tc.project_parameters(id: 'GetProjectWithNoParameters')
+        parameters.should be_empty
+      end
+
+      it 'should raise an error if the project does not exist' do
+        expect { @tc.project_parameters(id: 'missing')}
+      end
+    end
+
+    describe '.parent_project' do
+      it 'should fetch the parent project for a given project' do
+        parent = @tc.parent_project(id: 'GetProjectWithParent').should_not be_nil
+      end
+
+      it 'should return nil if there is no parent project for a given project' do
+        parent = @tc.parent_project(id: 'GetProjectWithNoParent').should be_nil
+      end
+
+      it 'should raise an error if the project does not exist' do
+        expect { @tc.parent_project(id: 'missing') }
+      end
+    end
+  end
+
+  # POST Requests
+  describe 'POST', :vcr do
+
+    before(:all) do
+      configure_client_with_authentication
+    end
+
+    describe '.create_project' do
+      it 'should create a project' do
+        response = @tc.create_project('PostCreateProject')
+        response.id.should eq('PostCreateProject')
+      end
+    end
+
+    describe '.copy_project' do
+      it 'should copy a project' do
+        @tc.create_project('PostProjectToBeCopied')
+        source_project = @tc.project(id: 'PostProjectToBeCopied')
+        copied_project_name = 'PostCopyProject'
+        response = @tc.copy_project(
+          source_project.id,
+          copied_project_name,
+          :copyAllAssociatedSettings => true
+        )
+        response.name.should eq(copied_project_name)
+      end
+    end
+  end
+
+  describe 'DELETE', :vcr do
+
+    before(:all) do
+      configure_client_with_authentication
+    end
+
+    describe '.delete_project' do
+      it 'should delete a project' do
+        response = @tc.create_project('ProjectToDelete')
+        @tc.delete_project(response.id).should be_nil
+      end
+    end
+
+    describe '.delete_project_parameter' do
+      it 'should delete a project parameter' do
+        project_id = 'DeleteProjectParameters'
+        param_to_delete = 'delete-this-param'
+        @tc.create_project(project_id)
+        @tc.set_project_parameter(project_id, param_to_delete, 'delete-me')
+        response = @tc.delete_project_parameter(project_id, param_to_delete)
+        response.should be_nil
+      end
+    end
+  end
+
+  describe 'PUT', :vcr do
+
+    before(:all) do
+      configure_client_with_authentication
+    end
+
+    describe '.set_project_parameter' do
+      it 'should set a project parameter' do
+        project_id = 'PutCreateProjectParam'
+        param_name = 'set-with-param'
+        param_value = 'some-value'
+        @tc.create_project(project_id)
+        @tc.set_project_parameter(project_id, param_name, param_value).should eq(param_value)
+      end
+    end
+
+    describe '.set_project_field' do
+      it 'should set a projects name' do
+        project_id = 'PutSetProjectNameField'
+        @tc.create_project(project_id)
+        field_value = 'PutNewProjectName'
+        @tc.set_project_field(project_id, 'name', field_value).should eq(field_value)
+      end
+
+      it 'should set a projects description' do
+        project_id = 'PutSetProjectDescriptionField'
+        @tc.create_project(project_id)
+        field_value = 'description-changed-by-test'
+        @tc.set_project_field(project_id, 'description', field_value).should eq(field_value)
+      end
+
+      it 'should archive a project' do
+        project_id = 'PutSetProjectArchiveField'
+        @tc.create_project(project_id)
+        field_value = 'true'
+        @tc.set_project_field(project_id, 'archived', field_value).should eq(field_value)
+      end
+    end
+
+    describe '.set_parent_project' do
+      it 'should set a parent project for a given project' do
+        project_id = 'PutSetParentProject'
+        @tc.create_project(project_id)
+
+        parent_project_id = 'PutParentProject'
+        @tc.create_project(parent_project_id)
+
+        @tc.set_parent_project(project_id, parent_project_id)['id'].should eq(project_id)
+      end
+
+      it 'should raise an error if the parent project does not exist' do
+        expect { @tc.parent_project('GetProjectWithoutParent', 'missing') }.to raise_error
+      end
+
+      it 'should raise an error if the child project does not exist' do
+        expect { @tc.parent_project('missing', 'GetParentProject') }.to raise_error
+      end
+    end
+  end
+end