def test_find_multiple_nested_sub_views(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) parent1 = jk.create_view("test_find_multiple_nested_sub_views_parent1", NestedView) with clean_view(parent1): parent2 = parent1.create_view("test_find_multiple_nested_sub_views_parent2", NestedView) with clean_view(parent2): expected_view_name = "test_find_multiple_nested_sub_views_child" # Views in Jenkins must be unique within the same parent view, but # nested views may contain sub-views with the same name as their # ancestors / siblings. So we create 2 views with the same name in # each of our parent views to make sure they get resolved correctly child1 = parent1.create_view(expected_view_name, ListView) assert child1 is not None with clean_view(child1): child2 = parent2.create_view(expected_view_name, ListView) assert child2 is not None with clean_view(child2): results = parent1.find_all_views(expected_view_name) assert results is not None assert isinstance(results, list) assert len(results) == 2 assert results[0].name == expected_view_name assert results[1].name == expected_view_name
def test_plugin_longname(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) results = jk.plugin_manager.plugins assert results[0].long_name is not None assert isinstance(results[0].long_name, type(u""))
def test_plugin_required_dependencies(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) # HACK: There's no easy way for us to tell which plugins may be installed # by the test framework in the future, so we just "assume" that there # will always be at least one that has at least one transitive # dependency. Let's find one. plugin = None for cur_plugin in jk.plugin_manager.plugins: # initial sanity check: make sure our return type is correct assert isinstance(cur_plugin.required_dependencies, list) if len(cur_plugin.required_dependencies) > 0: plugin = cur_plugin break # verify object state assert plugin is not None assert isinstance(plugin.required_dependencies, list) assert len(plugin.required_dependencies) > 0 assert isinstance(plugin.required_dependencies[0], dict) assert len(plugin.required_dependencies[0].keys()) == 2 assert "shortName" in plugin.required_dependencies[0] assert "version" in plugin.required_dependencies[0] assert isinstance(plugin.required_dependencies[0]["shortName"], type(u"")) assert isinstance(plugin.required_dependencies[0]["version"], type(u""))
def test_add_conditional_builder(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) expected_job_name = "test_add_conditional_builder" jb = jk.create_job(expected_job_name, FreestyleJob) with clean_job(jb): expected_output = "Here is my sample output..." expected_cmd = "echo " + expected_output shell_builder = ShellBuilder.create(expected_cmd) condition = AlwaysRun.create() conditional_builder = ConditionalBuilder.create(condition, shell_builder) jb.add_builder(conditional_builder) # Get a fresh copy of our job to ensure we have an up to date # copy of the config.xml for the job async_assert(lambda: jk.find_job(expected_job_name).builders) builders = jk.find_job(expected_job_name).builders # Make sure the builder was successfully added and it's response # data can be parsed correctly assert isinstance(builders, list) assert len(builders) == 1 assert isinstance(builders[0], ConditionalBuilder) assert builders[0].builder is not None assert isinstance(builders[0].builder, ShellBuilder) assert builders[0].builder.script == expected_cmd assert_elements_equal(builders[0].builder.node, shell_builder.node)
def test_never_run_condition(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) expected_job_name = "test_never_run_condition" jb = jk.create_job(expected_job_name, FreestyleJob) with clean_job(jb): expected_output = "Here is my sample output..." shell_builder = ShellBuilder.create("echo " + expected_output) condition = NeverRun.create() conditional_builder = ConditionalBuilder.create(condition, shell_builder) jb.add_builder(conditional_builder) # Get a fresh copy of our job to ensure we have an up to date # copy of the config.xml for the job async_assert(lambda: jk.find_job(expected_job_name).builders) builders = jk.find_job(expected_job_name).builders # Make sure the builder was correctly configured assert builders[0].condition is not None assert isinstance(builders[0].condition, NeverRun) assert builders[0].condition.get_friendly_name() == "never" # Finally, just to be sure our build actually did something relevant # we make sure the output from our shell command appears in the # build output for a build (ie: to ensure the conditional build step # actually ran) jb.start_build() async_assert(lambda: jb.last_build) assert expected_output not in jb.last_build.console_output
def test_wait_for_idle(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) node = jk.nodes[0] expected_job_name = "test_wait_for_idle_job" jb = jk.create_job(expected_job_name, FreestyleJob) with clean_job(jb): jb.quiet_period = 0 shell_builder = ShellBuilder.create("sleep 2") jb.add_builder(shell_builder) # Get a fresh copy of our job to ensure we have an up to date # copy of the config.xml for the job async_assert(lambda: jk.find_job(expected_job_name).builders) # Trigger a build jb.start_build() # The 'last_build' reference becomes available as soon as the previously # triggered build exits the queue and starts running. So we wait for the # last build to become valid before checking the node activity async_assert(lambda: jb.last_build) assert node.is_idle is False assert node.wait_for_idle() assert node.is_idle
def test_add_artifact_deployer_publisher_entry(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) job_name = "test_add_artifact_deployer_publisher_entry" jb = jk.create_job(job_name, FreestyleJob) with clean_job(jb): publisher = ArtifactDeployer.instantiate() jb.add_publisher(publisher) expected_regex = "*.txt" expected_path = "/bin/data" entry = ArtifactDeployerEntry.instantiate(expected_regex, expected_path) publisher.add_entry(entry) # Get a fresh copy of our job to ensure we have an up to date # copy of the config.xml for the job async_assert(lambda: jk.find_job(job_name).publishers) pubs = jk.find_job(job_name).publishers assert len(pubs) == 1 cur_pub = pubs[0] assert isinstance(cur_pub, ArtifactDeployer) assert isinstance(cur_pub.entries, list) assert len(cur_pub.entries) == 1 cur_entry = cur_pub.entries[0] assert isinstance(cur_entry, ArtifactDeployerEntry) assert cur_entry.includes == expected_regex assert cur_entry.remote == expected_path
def test_multiple_upstream_jobs_recursive(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) parent_job_name = "test_multiple_upstream_jobs_recursive1" jb = jk.create_job(parent_job_name, FreestyleJob) with clean_job(jb): expected_name1 = "test_multiple_upstream_jobs_recursive2" jb2 = jk.create_job(expected_name1, FreestyleJob) with clean_job(jb2): expected_name2 = "test_multiple_upstream_jobs_recursive3" jb3 = jk.create_job(expected_name2, FreestyleJob) with clean_job(jb3): publisher1 = BuildTriggerPublisher.create([expected_name1]) jb.add_publisher(publisher1) publisher2 = BuildTriggerPublisher.create([expected_name2]) jb2.add_publisher(publisher2) async_assert(lambda: len(jb3.all_upstream_jobs) == 2) res = jb3.all_upstream_jobs all_names = [parent_job_name, expected_name1] assert isinstance(res, list) assert len(res) == 2 assert res[0].name in all_names assert res[1].name in all_names assert isinstance(res[0], FreestyleJob) assert isinstance(res[1], FreestyleJob)
def test_start_build(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) jb = jk.create_job("test_start_build", FreestyleJob) with clean_job(jb): jb.quiet_period = 0 jb.start_build()
def test_folder_find_job_not_found(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) jb = jk.create_job("test_folder_find_job_not_found", FolderJob) with clean_job(jb): jb2 = jb.find_job("SubJobThatDoesntExist") assert jb2 is None
def test_disable(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) jb = jk.create_job("test_disable", FreestyleJob) with clean_job(jb): jb.disable() assert jb.is_disabled
def test_build_queue(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) queue = jk.build_queue assert queue is not None assert isinstance(queue.items, list) assert len(queue.items) == 0
def test_find_node(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) node = jk.find_node("master") assert node is not None assert node.name == "master"
def test_create_view(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) vw = jk.create_view("test_create_view", ListView) with clean_view(vw): assert vw is not None assert vw.name == "test_create_view"
def test_trigger_with_current_build_params(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) upstream_name = "test_trigger_with_current_build_params" jb = jk.create_job(upstream_name, FreestyleJob) with clean_job(jb): downstream_name = "sample_job" new_trigger = BuildTriggerConfig.instantiate([downstream_name]) cur_bld_params = CurrentBuildParams.instantiate() new_trigger.add_build_param(cur_bld_params) new_pub = ParameterizedBuildTrigger.instantiate([new_trigger]) jb.add_publisher(new_pub) # Get a fresh copy of our job to ensure we have an up to date # copy of the config.xml for the job async_assert(lambda: jk.find_job(upstream_name).publishers) pubs = jk.find_job(upstream_name).publishers assert len(pubs) == 1 cur_pub = pubs[0] assert len(cur_pub.triggers) == 1 cur_trig = cur_pub.triggers[0] assert len(cur_trig.build_params) == 1 cur_param_cfg = cur_trig.build_params[0] assert isinstance(cur_param_cfg, CurrentBuildParams)
def test_quiet_period(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) jb = jk.create_job("test_quiet_period", FreestyleJob) with clean_job(jb): jb.quiet_period = 0 # first set our quiet period expected_duration = 10 jb.quiet_period = expected_duration expected_output = "Testing my quiet period" failing_step = ShellBuilder.create("echo " + expected_output) jb.add_builder(failing_step) async_assert(lambda: jb.builders) assert jb.quiet_period == expected_duration # Launch a build and time how long it takes to complete start = timeit.default_timer() jb.start_build() async_assert(lambda: jb.last_build, expected_duration + 5) duration = timeit.default_timer() - start assert duration >= expected_duration bld = jb.last_build assert expected_output in bld.console_output
def test_param_trigger(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) upstream_name = "test_param_trigger" jb = jk.create_job(upstream_name, FreestyleJob) with clean_job(jb): downstream_name = "sample_job" new_trigger = BuildTriggerConfig.instantiate([downstream_name]) pub = ParameterizedBuildTrigger.instantiate([new_trigger]) jb.add_publisher(pub) # Get a fresh copy of our job to ensure we have an up to date # copy of the config.xml for the job async_assert(lambda: jk.find_job(upstream_name).publishers) pubs = jk.find_job(upstream_name).publishers assert isinstance(pubs, list) assert len(pubs) == 1 assert isinstance(pubs[0], ParameterizedBuildTrigger) triggers = pubs[0].triggers assert isinstance(triggers, list) assert len(triggers) == 1 names = triggers[0].job_names assert isinstance(names, list) assert len(names) == 1 assert names[0] == downstream_name assert triggers[0].condition == "SUCCESS"
def test_clone_job(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) jb = jk.create_job("test_clone_job", FreestyleJob) with clean_job(jb): # add a builder to our source job so we can check to make sure the # configuration has been properly cloned expected_script = "echo Hello From TestCloneJob" failing_step = ShellBuilder.create(expected_script) jb.add_builder(failing_step) async_assert(lambda: jb.builders) # now, clone our job configuration and make sure the entire config # has been cloned correctly expected_name = "test_clone_job2" jb_clone = jb.clone(expected_name) with clean_job(jb_clone): assert jb_clone is not None assert jb_clone.name == expected_name assert jb_clone.is_disabled results = jb_clone.builders assert results is not None assert isinstance(results, list) assert len(results) == 1 assert isinstance(results[0], ShellBuilder) assert results[0].script == expected_script
def test_artifacts_archived(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) job_name = "test_artifacts_archived_job" jb = jk.create_job(job_name, FreestyleJob) with clean_job(jb): publisher = ArtifactArchiverPublisher.create("*.txt") jb.add_publisher(publisher) # Wait until our publisher config get's applied async_assert(lambda: jk.find_job(job_name).publishers) expected_file = "test_artifacts_archived_job.txt" shell_builder = ShellBuilder.create("echo hello > " + expected_file) jb.add_builder(shell_builder) # Wait until our builder get's applied async_assert(lambda: jk.find_job(job_name).builders) # Next, trigger a build jb.start_build() async_assert(lambda: len(jb.all_builds) == 1) # finally, make sure the list or archived artifacts looks correct bld = jb.all_builds[0] results = bld.artifact_urls assert isinstance(results, list) assert len(results) == 1 assert expected_file in results[0]
def test_build_blocker_functionality(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) job_name1 = "test_build_blocker_functionality1" jb1 = jk.create_job(job_name1, FreestyleJob) with clean_job(jb1): job_name2 = "test_build_blocker_functionality2" jb2 = jk.create_job(job_name2, FreestyleJob) with clean_job(jb2): expected_jobs = job_name2 build_blocker = BuildBlockerProperty.create(expected_jobs) jb1.quiet_period = 0 jb1.add_property(build_blocker) # Get a fresh copy of our job to ensure we have an up to date # copy of the config.xml for the job async_assert(lambda: jk.find_job(job_name1).properties) build_step = ShellBuilder.create("sleep 10") jb2.quiet_period = 0 jb2.add_builder(build_step) async_assert(lambda: jb2.builders) queue2 = jb2.start_build() async_assert(lambda: not queue2.waiting) queue1 = jb1.start_build() assert job_name2 in queue1.reason queue2.build.abort() assert queue1.waiting is False
def test_add_then_edit_unstable_return_code(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) job_name = "test_add_then_edit_unstable_return_code" jb = jk.create_job(job_name, FreestyleJob) with clean_job(jb): jb.quiet_period = 0 rcode = 12 failing_step = ShellBuilder.create("exit " + str(rcode)) failing_step.unstable_return_code = 1 jb.add_builder(failing_step) # Edit the build step using the original failed_step object - # these changes should still get applied to the job the step is # associated with failing_step.unstable_return_code = rcode # Get a fresh copy of our job to ensure we have an up to date # copy of the config.xml for the job async_assert(lambda: jk.find_job(job_name).builders) jb2 = jk.find_job(job_name) # run a build to see if the changes were auto applied jb2.start_build() async_assert(lambda: jb2.last_build) bld = jb2.last_build # Because of our changes to the configuration, the returned error code # should have resulted in an unstable build instead of a failed build assert bld.result == "UNSTABLE"
def test_add_then_edit_build_blocker(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) job_name = "test_add_then_edit_build_blocker" jb = jk.create_job(job_name, FreestyleJob) with clean_job(jb): build_blocker = BuildBlockerProperty.create("MyCoolJob") jb.add_property(build_blocker) # edit the original build blocker object - changes should still get # applied to the underlying Jenkins job expected_job_names = ["SomeOtherJob1", "SomeOtherJob2"] build_blocker.blockers = expected_job_names # Get a fresh copy of our job to ensure we have an up to date # copy of the config.xml for the job async_assert(lambda: jk.find_job(job_name).properties) # Now, get a clean reference to the job jb2 = jk.find_job(job_name) props = jb2.properties blockers = props[0].blockers assert isinstance(blockers, list) assert len(blockers) == 2 assert expected_job_names[0] in blockers assert expected_job_names[1] in blockers
def test_always_run_condition(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) expected_job_name = "test_always_run_condition" jb = jk.create_job(expected_job_name, FreestyleJob) with clean_job(jb): expected_output = "Here is my sample output..." expected_cmd = "echo " + expected_output shell_builder = ShellBuilder.create(expected_cmd) condition = AlwaysRun.create() conditional_builder = ConditionalBuilder.create(condition, shell_builder) jb.add_builder(conditional_builder) # Wait until our job config has been applied successfully async_assert(lambda: jk.find_job(expected_job_name).builders) # Make sure the condition is loaded correctly builders = jk.find_job(expected_job_name).builders assert isinstance(builders[0].condition, AlwaysRun) assert builders[0].condition.get_friendly_name() == "always" # Run a build and make sure the build operation actually executed jb.start_build() async_assert(lambda: jb.last_build) assert expected_output in jb.last_build.console_output
def test_clone_view(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) original_view_name = "test_clone_view" vw1 = jk.create_view(original_view_name, SectionedView) with clean_view(vw1): expected_section_name = "MyNewSection" vw1.add_section("hudson.plugins.sectioned_view.TextSection", expected_section_name) expected_view_name = "test_clone_view2" vw2 = vw1.clone(expected_view_name) assert vw2 is not None with clean_view(vw2): tmp_view = jk.find_view(expected_view_name) assert tmp_view is not None assert tmp_view.name == expected_view_name result = tmp_view.sections assert result is not None assert isinstance(result, list) assert len(result) == 1 assert result[0].name == expected_section_name
def test_find_plugin_by_shortname_doesnt_exist(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) result = jk.plugin_manager.find_plugin_by_shortname( "should_not_see_me_fubar_asdf") assert result is None
def test_rename_view(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) original_view_name = "test_rename_view" v = jk.create_view(original_view_name, SectionedView) try: expected_section_name = "MyNewSection" v.add_section("hudson.plugins.sectioned_view.TextSection", expected_section_name) expected_view_name = "test_rename_view2" v.rename(expected_view_name) assert jk.find_view(original_view_name) is None finally: tmp = jk.find_view(original_view_name) if tmp: tmp.delete() with clean_view(v): assert v.name == expected_view_name tmp_view = jk.find_view(expected_view_name) assert tmp_view is not None assert tmp_view.name == expected_view_name result = tmp_view.sections assert result is not None assert isinstance(result, list) assert len(result) == 1 assert result[0].name == expected_section_name
def test_plugin_info_url(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) results = jk.plugin_manager.plugins assert results[0].info_url is not None assert isinstance(results[0].info_url, type(u""))
def test_find_view(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) expected_name = "all" v = jk.find_view(expected_name) assert isinstance(v, AllView)
def test_add_string_parameter(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) job_name = "test_add_string_parameter" jb = jk.create_job(job_name, FreestyleJob) with clean_job(jb): expected_param_name = "param1" expected_param_val = "fubar" expected_param_desc = "My Description" expected_param_trim = False str_param = ParameterizedBuildStringParameter.create( expected_param_name, expected_param_val, expected_param_desc, expected_param_trim) build_params = ParameterizedBuild.create([str_param]) jb.add_property(build_params) # Get a fresh copy of our job to ensure we have an up to date # copy of the config.xml for the job async_assert(lambda: jk.find_job(job_name).properties) properties = jk.find_job(job_name).properties assert isinstance(properties, list) assert len(properties) == 1 assert isinstance(properties[0], ParameterizedBuild) params = properties[0].parameters assert isinstance(params, list) assert len(params) == 1 act_param = params[0] assert isinstance(act_param, ParameterizedBuildStringParameter) assert act_param.name == expected_param_name assert act_param.default_value == expected_param_val assert act_param.description == expected_param_desc assert act_param.trim == expected_param_trim
def test_create_multibranch_pipeline_job(jenkins_env): jk = Jenkins(jenkins_env["url"], (jenkins_env["admin_user"], jenkins_env["admin_token"])) expected_name = "test_create_multibranch_pipeline_job" jb = jk.create_job(expected_name, MultibranchPipelineJob) with clean_job(jb): assert jb is not None assert jb.name == expected_name