Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inclusive naming changes #149

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Release date: 2019-10-22
> **NOTE**: To revert to previous release behavior, pass the system property
> `org.jenkinsci.plugins.durabletask.BourneShellScript.FORCE_SHELL_WRAPPER=true` to the Java command line used to start Jenkins.

- Update ssh-slaves ([PR \#100](https://github.com/jenkinsci/durable-task-plugin/pull/100))
- Update ssh-agents ([PR \#100](https://github.com/jenkinsci/durable-task-plugin/pull/100))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slightly different for linguistic reasons. The previous entry used the "plugin ID" which is not well known to users and is unchanging even for inclusive naming. Let's use the plugin name rather than the identifier

Suggested change
- Update ssh-agents ([PR \#100](https://github.com/jenkinsci/durable-task-plugin/pull/100))
- Update SSH Build Agents plugin ([PR \#100](https://github.com/jenkinsci/durable-task-plugin/pull/100))

- Do not fail tests when run on a machine without Docker installed.
([PR \#101](https://github.com/jenkinsci/durable-task-plugin/pull/101))
- Improve watcher logging
Expand Down Expand Up @@ -89,7 +89,7 @@ Release date: 2019-07-05
be used to enable zombie-reaping in docker containers (--init) or kubernetes pods (shared
process namespaces).
- Bugfix: Use `sh` to run shell scripts rather than attempting to
use the absolute path to the default shell from the master on
use the absolute path to the default shell from the Controller on
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lower case rather than upper case inside the sentence

Suggested change
use the absolute path to the default shell from the Controller on
use the absolute path to the default shell from the controller on

agents. ([PR \#95](https://github.com/jenkinsci/durable-task-plugin/pull/95))
- Bugfix: Make PowerShell exit codes propagate correctly. Fixes a
regression from version 1.23
Expand Down Expand Up @@ -129,7 +129,7 @@ Release date: 2018-09-25
processes from 15 seconds to 5 minutes
([JENKINS-48300](https://issues.jenkins-ci.org/browse/JENKINS-48300))
- Developer: Define API for pushing durable task logs from build
agents directly instead of having the Jenkins master pull logs from
agents directly instead of having the Jenkins controller pull logs from
build agents
([JENKINS-52165](https://issues.jenkins-ci.org/browse/JENKINS-52165))

Expand Down Expand Up @@ -338,7 +338,7 @@ Release date: 2015-12-03
Release date: 2015-04-08

- Do not kill a one-shot agent merely because a flyweight task
happened to run on it (rather than on master as usual). Works around
happened to run on it (rather than on the Controller as usual). Works around
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lower case

Suggested change
happened to run on it (rather than on the Controller as usual). Works around
happened to run on it (rather than on the controller as usual). Works around

a bug in the Multibranch API plugin.

### Version 1.5
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>ssh-slaves</artifactId>
<artifactId>ssh-agents</artifactId>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's an identifier, needs to remain the same

Suggested change
<artifactId>ssh-agents</artifactId>
<artifactId>ssh-slaves</artifactId>

<scope>test</scope>
</dependency>
</dependencies>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ private List<String> scriptLauncherCmd(ShellController c, FilePath ws, @CheckFor

/*package*/ static final class ShellController extends FileMonitoringController {

/** Last time we checked the timestamp, in nanoseconds on the master. */
/** Last time we checked the timestamp, in nanoseconds on the Controller. */
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lower case

Suggested change
/** Last time we checked the timestamp, in nanoseconds on the Controller. */
/** Last time we checked the timestamp, in nanoseconds on the controller. */

private transient long lastCheck;
/** Last-observed modification time of {@link FileMonitoringTask.FileMonitoringController#getLogFile(FilePath)} on remote computer, in milliseconds. */
private transient long checkedTimestamp;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
public abstract class Controller implements Serializable {

/**
* Begins watching the process asynchronously, so that the master may receive notification when output is available or the process has exited.
* Begins watching the process asynchronously, so that the controller may receive notification when output is available or the process has exited.
* This should be called as soon as the process is launched, and thereafter whenever reconnecting to the agent.
* You should not call {@link #writeLog} or {@link #cleanup} in this case; you do not need to call {@link #exitStatus(FilePath, Launcher)} frequently,
* though it is advisable to still call it occasionally to verify that the process is still running.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
import edu.umd.cs.findbugs.annotations.NonNull;

/**
* A task which may be run asynchronously on a build node and withstand disconnection of the slave agent.
* A task which may be run asynchronously on a build node and withstand disconnection of the agent.
* Should have a descriptor, and a {@code config.jelly} for form data binding.
*/
public abstract class DurableTask extends AbstractDescribableImpl<DurableTask> implements ExtensionPoint {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -640,7 +640,7 @@ private static class Watcher implements Runnable {
Timer.get().schedule(this, 100, TimeUnit.MILLISECONDS);
}
} catch (Exception x) {
// note that LOGGER here is going to the agent log, not master log
// note that LOGGER here is going to the agent log, not the Controller log
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lower case

Suggested change
// note that LOGGER here is going to the agent log, not the Controller log
// note that LOGGER here is going to the agent log, not the controller log

LOGGER.log(Level.WARNING, "giving up on watching " + controller.controlDir, x);
// Typically this will have been inside Handler.output, e.g.:
// hudson.remoting.ChannelClosedException: channel is already closed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

/**
* A remote handler which may be sent to an agent and handle process output and results.
* If it needs to communicate with the master, you may use {@link VirtualChannel#export}.
* If it needs to communicate with the Controller, you may use {@link VirtualChannel#export}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* If it needs to communicate with the Controller, you may use {@link VirtualChannel#export}.
* If it needs to communicate with the controller, you may use {@link VirtualChannel#export}.

I assume the same here

* @see Controller#watch
*/
public abstract class Handler implements Serializable { // TODO 2.107+ SerializableOnlyOverRemoting
Expand All @@ -57,7 +57,7 @@ public abstract class Handler implements Serializable { // TODO 2.107+ Serializa
* <p>Any metadata associated with the process may be deleted after this call completes, rendering subsequent {@link Controller} calls unsatisfiable.
* <p>Note that unlike {@link Controller#exitStatus(FilePath, Launcher)}, no specialized {@link Launcher} is available on the agent,
* so if there are specialized techniques for determining process liveness they will not be considered here;
* you still need to occasionally poll for an exit status from the master.
* you still need to occasionally poll for an exit status from the controller.
* @param code the exit code, if known (0 conventionally represents success); may be negative for anomalous conditions such as a missing process
* @param output standard output captured, if {@link DurableTask#captureOutput} was called; else null
* @throws Exception if anything goes wrong, this watch is deactivated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
import java.util.logging.Logger;

/**
* Retention strategy that allows a cloud slave to run only a single build before disconnecting.
* Retention strategy that allows a cloud agent to run only a single build before disconnecting.
* A {@link ContinuableExecutable} does not trigger termination.
*/
public final class OnceRetentionStrategy extends CloudRetentionStrategy implements ExecutorListener {
Expand All @@ -53,7 +53,7 @@ public final class OnceRetentionStrategy extends CloudRetentionStrategy implemen

/**
* Creates the retention strategy.
* @param idleMinutes number of minutes of idleness after which to kill the slave; serves a backup in case the strategy fails to detect the end of a task
* @param idleMinutes number of minutes of idleness after which to kill the agent; serves a backup in case the strategy fails to detect the end of a task
*/
public OnceRetentionStrategy(int idleMinutes) {
super(idleMinutes);
Expand All @@ -62,7 +62,7 @@ public OnceRetentionStrategy(int idleMinutes) {

@Override
public long check(final AbstractCloudComputer c) {
// When the slave is idle we should disable accepting tasks and check to see if it is already trying to
// When the agent is idle we should disable accepting tasks and check to see if it is already trying to
// terminate. If it's not already trying to terminate then lets terminate manually.
if (c.isIdle() && !disabled) {
final long idleMilliseconds = System.currentTimeMillis() - c.getIdleStartMilliseconds();
Expand Down