Summary:

Add manual trigger run and retry for JenkinsCI integration.

Review Request #11225 — Created Oct. 15, 2020 and submitted Dec. 4, 2020, 2:18 a.m.

Information
Owner:	MarcusBoay
Repository:	rbintegrations
Branch:	master
Bugs:
Depends On:
Reviewers
Groups:	rbintegrations
People:

Description

Add manual trigger to JenkinsCI.

This change adds the ability for Integrations to run JenkinsCI manually.
A checkbox is added to the JenkinsCI form that indicates if JenkinsCI should
only run manually.

The password form label has also been updated to emphasize using an API token
instead of the user's password since newer versions of Jenkins only works with
API tokens.

This change also fixes the Jenkins API failing for Review Board 3 because
request.open() was not valid.

Based on work by David Trowbridge: /r/11130

Testing Done

Manually tested on Review Board 3. Jenkins was set up with Docker and
connected to a GitHub repository and Review Board 3. A Jenkins build was
not run when the manually run checkbox is unchecked and is run when the
field is checked. Clicking on the 'Run' button runs the Jenkins build.

Verified the disabled/enabled run manually field by testing on Review Board
3.0.18, 3.0.19 and 4.0.x.

Verified retry functionality when state is in ERROR and TIMEOUT states.

Unit tests to verify that a build is not run when the manually run
configuration is checked and to verify that a build is run when the signal is
emitted.

Commits

Summary
	Add manual trigger and retry to JenkinsCI.

Screenshots

Issues

Description	From	Last Updated
F401 'importlib' imported but unused	reviewbot	Nov. 4, 2020, 5:37 p.m.

flake8 passed.

JSHint passed.

Change Summary:

Finalize WIP

Summary:

-	[WIP] Add manual trigger to JenkinsCI.
+	Add manual trigger to JenkinsCI integration.

Description:

		Add manual trigger to JenkinsCI.

		This change adds the ability for Integrations to run JenkinsCI manually.
~		A checkbox is added to the JenkinsCI form that indicates if JenkinsCI should only
~		run manually.
	~	A checkbox is added to the JenkinsCI form that indicates if JenkinsCI should
	~	only run manually.

		The password form label has also been updated to emphasize using an API token
		instead of the user's password since newer versions of Jenkins only works with
		API tokens.

	+	This change also fixes the Jenkins API failing for Review Board 3 because
	+	`request.open()` was not valid.
	+
		Based on work by David Trowbridge: /r/11130

Testing Done:

~		Tested on Review Board 3. More to come.
	~	Manually tested on Review Board 3. Jenkins was set up with Docker and
	+	connected to a GitHub repository and Review Board 3. A Jenkins build was
	+	not run when the manually run checkbox is unchecked and is run when the
	+	field is checked. Clicking on the 'Run' button runs the Jenkins build.
	+
	+	Unit tests to verify that a build is not run when a the manually run
	+	configuration is checked and to verify that a build is run when the signal is
	+	emitted.

Commits:

	Summary
-	Add manual trigger to JenkinsCI.
+	Add manual trigger to JenkinsCI.
+	Refactor Jenkins tests with wrapper spy on function.
+	Add JenkinsCI tests for manual run.

Diff:

Revision 2 (+594 -172)

Show changes

	rbintegrations/jenkinsci/api.py
	rbintegrations/jenkinsci/forms.py
	rbintegrations/jenkinsci/integration.py
	rbintegrations/jenkinsci/tests.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Testing Done:

		Manually tested on Review Board 3. Jenkins was set up with Docker and
		connected to a GitHub repository and Review Board 3. A Jenkins build was
		not run when the manually run checkbox is unchecked and is run when the
		field is checked. Clicking on the 'Run' button runs the Jenkins build.

~		Unit tests to verify that a build is not run when a the manually run
	~	Unit tests to verify that a build is not run when the manually run
		configuration is checked and to verify that a build is run when the signal is
		emitted.

Change Summary:

Minor documentation fixup

Commits:

	Summary
-	Add manual trigger to JenkinsCI.
-	Refactor Jenkins tests with wrapper spy on function.
-	Add JenkinsCI tests for manual run.
+	Add manual trigger to JenkinsCI.
+	Refactor Jenkins tests with wrapper spy on function.
+	Add JenkinsCI tests for manual run.

Diff:

Revision 3 (+594 -172)

Show changes

	rbintegrations/jenkinsci/api.py
	rbintegrations/jenkinsci/forms.py
	rbintegrations/jenkinsci/integration.py
	rbintegrations/jenkinsci/tests.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Disable run manually field on older versions of Review Board

Commits:

	Summary
-		Add manual trigger to JenkinsCI.
-		Refactor Jenkins tests with wrapper spy on function.
-		Add JenkinsCI tests for manual run.
+		Add manual trigger to JenkinsCI.

Diff:

Revision 4 (+624 -174)

Show changes

	rbintegrations/jenkinsci/api.py
	rbintegrations/jenkinsci/forms.py
	rbintegrations/jenkinsci/integration.py
	rbintegrations/jenkinsci/tests.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Testing Done:

		Manually tested on Review Board 3. Jenkins was set up with Docker and
		connected to a GitHub repository and Review Board 3. A Jenkins build was
		not run when the manually run checkbox is unchecked and is run when the
		field is checked. Clicking on the 'Run' button runs the Jenkins build.

	+	Tested on Review Board 3.0.19, 3.0.18 and 4.0.x to verify the disabled
	+	run manually field.
	+
		Unit tests to verify that a build is not run when the manually run
		configuration is checked and to verify that a build is run when the signal is
		emitted.

Testing Done:

		Manually tested on Review Board 3. Jenkins was set up with Docker and
		connected to a GitHub repository and Review Board 3. A Jenkins build was
		not run when the manually run checkbox is unchecked and is run when the
		field is checked. Clicking on the 'Run' button runs the Jenkins build.

~		Tested on Review Board 3.0.19, 3.0.18 and 4.0.x to verify the disabled
~		run manually field.
	~	Verified the disabled/enable run manually field by testing on Review Board
	~	3.0.18, 3.0.19 and 4.0.x.

		Unit tests to verify that a build is not run when the manually run
		configuration is checked and to verify that a build is run when the signal is
		emitted.

Testing Done:

		Manually tested on Review Board 3. Jenkins was set up with Docker and
		connected to a GitHub repository and Review Board 3. A Jenkins build was
		not run when the manually run checkbox is unchecked and is run when the
		field is checked. Clicking on the 'Run' button runs the Jenkins build.

~		Verified the disabled/enable run manually field by testing on Review Board
	~	Verified the disabled/enabled run manually field by testing on Review Board
		3.0.18, 3.0.19 and 4.0.x.

		Unit tests to verify that a build is not run when the manually run
		configuration is checked and to verify that a build is run when the signal is
		emitted.

Change Summary:

Fix typo in can_retry extra_data

Commits:

	Summary
-		Add manual trigger to JenkinsCI.
+		Add manual trigger and retry to JenkinsCI.

Diff:

Revision 5 (+624 -174)

Show changes

	rbintegrations/jenkinsci/api.py
	rbintegrations/jenkinsci/forms.py
	rbintegrations/jenkinsci/integration.py
	rbintegrations/jenkinsci/tests.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Testing Done:

		Manually tested on Review Board 3. Jenkins was set up with Docker and
		connected to a GitHub repository and Review Board 3. A Jenkins build was
		not run when the manually run checkbox is unchecked and is run when the
		field is checked. Clicking on the 'Run' button runs the Jenkins build.

		Verified the disabled/enabled run manually field by testing on Review Board
		3.0.18, 3.0.19 and 4.0.x.

	+	Verified retry functionality when state is in ERROR and TIMEOUT states.
	+
		Unit tests to verify that a build is not run when the manually run
		configuration is checked and to verify that a build is run when the signal is
		emitted.

Summary:

-	Add manual trigger to JenkinsCI integration.
+	Add manual trigger run and retry for JenkinsCI integration.

Change Summary:

Update based on comments on CircleCI patch

Commits:

	Summary
-		Add manual trigger and retry to JenkinsCI.
+		Add manual trigger and retry to JenkinsCI.

Diff:

Revision 6 (+582 -174)

Show changes

	rbintegrations/jenkinsci/api.py
	rbintegrations/jenkinsci/forms.py
	rbintegrations/jenkinsci/integration.py
	rbintegrations/jenkinsci/tests.py

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

rbintegrations/jenkinsci/forms.py (Diff revision 6)
Show all issues
```
F401 'importlib' imported but unused
```

Change Summary:

Fix ReviewBot issues

Commits:

	Summary
-		Add manual trigger and retry to JenkinsCI.
+		Add manual trigger and retry to JenkinsCI.

Diff:

Revision 7 (+580 -174)

Show changes

	rbintegrations/jenkinsci/api.py
	rbintegrations/jenkinsci/forms.py
	rbintegrations/jenkinsci/integration.py
	rbintegrations/jenkinsci/tests.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-2.0.x (61cf6b5)