Merge pull request #9 from jenkinsci/modernize

Modernize the plugin

.github/workflows/cd.yaml

@@ -0,0 +1,15 @@
+# Note: additional setup is required, see https://www.jenkins.io/redirect/continuous-delivery-of-plugins
+
+name: cd
+on:
+ workflow_dispatch:
+ check_run:
+ types:
+ - completed
+
+jobs:
+ maven-cd:
+ uses: jenkins-infra/github-reusable-workflows/.github/workflows/maven-cd.yml@v1
+ secrets:
+ MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
+ MAVEN_TOKEN: ${{ secrets.MAVEN_TOKEN }}

.gitignore

@@ -1,3 +1,4 @@
 /target/
 /work/
-*.hpl
+*.hpl
+.idea

.mvn/extensions.xml

@@ -0,0 +1,7 @@
+<extensions xmlns="http://maven.apache.org/EXTENSIONS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/EXTENSIONS/1.0.0 http://maven.apache.org/xsd/core-extensions-1.0.0.xsd">
+ <extension>
+ <groupId>io.jenkins.tools.incrementals</groupId>
+ <artifactId>git-changelist-maven-extension</artifactId>
+ <version>1.4</version>
+ </extension>
+</extensions>

.mvn/maven.config

@@ -0,0 +1,3 @@
+-Pconsume-incrementals
+-Pmight-produce-incrementals
+-Dchangelist.format=%d.v%s

Jenkinsfile

@@ -0,0 +1,4 @@
+buildPlugin(useContainerAgent: true, configurations: [
+ [platform: 'linux', jdk: '11'],
+ [platform: 'linux', jdk: '17']
+])

pom.xml

@@ -3,19 +3,19 @@
  <parent>
  <groupId>org.jenkins-ci.plugins</groupId>
  <artifactId>plugin</artifactId>
- <version>1.509.2</version>
+ <version>4.53</version>
  <relativePath />
  </parent>
 
  <groupId>sic.software</groupId>
  <name>Keychains and Provisioning Profiles Management</name>
  <description>This Jenkins plugin integrates a keychains and provisioning profiles managment for iOS and OSX projects build on a mac.</description>
  <artifactId>kpp-management-plugin</artifactId>
- <version>1.0.1-SNAPSHOT</version>
+ <version>${changelist}</version>
  <packaging>hpi</packaging>
  <url>http://wiki.jenkins-ci.org/display/JENKINS/Keychains+and+Provisioning+Profiles+Plugin</url>
  <scm>
- <connection>scm:git:ssh://github.com/jenkinsci/kpp-management-plugin.git</connection>
+ <connection>scm:git:https://github.com/jenkinsci/kpp-management-plugin.git</connection>
  <developerConnection>scm:git:ssh://[email protected]/jenkinsci/kpp-management-plugin.git</developerConnection>
  <url>https://github.com/jenkinsci/kpp-management-plugin</url>
  </scm>
@@ -27,38 +27,27 @@
  <distribution>repo</distribution>
  </license>
  </licenses>
-
- <developers>
- <developer>
- <id>michaelb</id>
- <name>Michael Bär</name>
- <email>[email protected]</email>
- </developer>
- </developers>
 
  <!-- get every artifact through repo.jenkins-ci.org, which proxies all the artifacts that we need -->
  <repositories>
  <repository>
  <id>repo.jenkins-ci.org</id>
- <url>http://repo.jenkins-ci.org/public/</url>
+ <url>https://repo.jenkins-ci.org/public/</url>
  </repository>
  </repositories>
 
  <pluginRepositories>
  <pluginRepository>
  <id>repo.jenkins-ci.org</id>
- <url>http://repo.jenkins-ci.org/public/</url>
+ <url>https://repo.jenkins-ci.org/public/</url>
  </pluginRepository>
  </pluginRepositories>
-
- <build> 
- <plugins> 
- <plugin> 
- <groupId>org.jenkins-ci.tools</groupId> 
- <artifactId>maven-hpi-plugin</artifactId> 
- <version>1.95</version> 
- </plugin> 
- </plugins> 
- </build> 
+
+ <properties>
+ <changelist>999999-SNAPSHOT</changelist>
+ <jenkins.version>2.361.4</jenkins.version>
+ <!-- TODO fix violations -->
+ <spotbugs.threshold>High</spotbugs.threshold>
+ </properties>
 
 </project>

src/main/java/com/sic/plugins/kpp/KPPKeychainsBuildWrapper.java

@@ -41,6 +41,8 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+
+import jenkins.model.Jenkins;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 /**
@@ -100,13 +102,11 @@ public Environment setUp(AbstractBuild build, Launcher launcher, BuildListener l
  /**
  * Copy the keychains configured for this build job to the workspace of the job.
  * @param build the current build
- * @throws IOException
- * @throws InterruptedException 
  */
  private void copyKeychainsToWorkspace(AbstractBuild build) throws IOException, InterruptedException {
  FilePath projectWorkspace = build.getWorkspace();
 
- Hudson hudson = Hudson.getInstance();
+ Jenkins hudson = Jenkins.get();
  FilePath hudsonRoot = hudson.getRootPath();
 
  if (copiedKeychains == null) {
@@ -131,7 +131,7 @@ public DescriptorImpl getDescriptor() {
  }
 
  /**
- * Descriptor of the {@link KPPKeychainBuildWrapper}.
+ * Descriptor of the KPPKeychainBuildWrapper.
  */
  @Extension
  public static final class DescriptorImpl extends BuildWrapperDescriptor {

src/main/java/com/sic/plugins/kpp/KPPManagementLink.java

@@ -37,6 +37,8 @@
 import java.security.NoSuchAlgorithmException;
 import java.util.List;
 import javax.servlet.ServletException;
+
+import jenkins.model.Jenkins;
 import net.sf.json.JSONObject;
 import org.apache.commons.fileupload.FileItem;
 import org.kohsuke.stapler.StaplerProxy;
@@ -103,15 +105,12 @@ public String getProvisioningProfilesPath() {
  * 
  * @param req Request
  * @param rsp Response
- * @throws ServletException
- * @throws IOException
- * @throws NoSuchAlgorithmException 
  */
  public void doUploadFile(StaplerRequest req, StaplerResponse rsp) throws
  ServletException,
  IOException,
  NoSuchAlgorithmException {
- Hudson.getInstance().checkPermission(Hudson.ADMINISTER);
+ Jenkins.get().checkPermission(Hudson.ADMINISTER);
 
  FileItem file = req.getFileItem("file");
  if (file == null || file.getSize() == 0) {
@@ -138,15 +137,12 @@ public void doUploadFile(StaplerRequest req, StaplerResponse rsp) throws
  * 
  * @param req Request
  * @param rsp Response
- * @throws ServletException
- * @throws IOException
- * @throws NoSuchAlgorithmException 
  */
  public void doSave(StaplerRequest req, StaplerResponse rsp) throws
  ServletException,
  IOException,
  NoSuchAlgorithmException {
- Hudson.getInstance().checkPermission(Hudson.ADMINISTER);
+ Jenkins.get().checkPermission(Hudson.ADMINISTER);
 
  JSONObject data = req.getSubmittedForm();
  List<KPPKeychain> keychains = req.bindJSONToList(KPPKeychain.class, data.get("keychain"));
@@ -175,15 +171,15 @@ public String getUrlName() {
 
  @Override
  public Object getTarget() {
- Hudson.getInstance().checkPermission(Hudson.ADMINISTER);
+ Jenkins.get().checkPermission(Hudson.ADMINISTER);
  KPPKeychainsProvider.getInstance().update();
  KPPProvisioningProfilesProvider.getInstance().update();
  return this;
  }
 
  @Override
  public void save() throws IOException {
- Hudson.getInstance().checkPermission(Hudson.ADMINISTER);
+ Jenkins.get().checkPermission(Hudson.ADMINISTER);
  KPPKeychainsProvider.getInstance().save();
  KPPProvisioningProfilesProvider.getInstance().save();
  }

src/main/java/com/sic/plugins/kpp/KPPNodeProperty.java

@@ -30,6 +30,7 @@
 import hudson.model.Node;
 import hudson.slaves.NodeProperty;
 import hudson.slaves.NodePropertyDescriptor;
+import jenkins.model.Jenkins;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 /**
@@ -63,7 +64,7 @@ public String getProvisioningProfilesPath() {
  public static KPPNodeProperty getCurrentNodeProperties() {
  KPPNodeProperty property = Computer.currentComputer().getNode().getNodeProperties().get(KPPNodeProperty.class);
  if(property == null) {
- property = Hudson.getInstance().getGlobalNodeProperties().get(KPPNodeProperty.class);
+ property = Jenkins.get().getGlobalNodeProperties().get(KPPNodeProperty.class);
  }
  return property;
  }

src/main/java/com/sic/plugins/kpp/KPPProvisioningProfilesBuildWrapper.java

@@ -43,6 +43,8 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+
+import jenkins.model.Jenkins;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 /**
@@ -103,13 +105,11 @@ public Environment setUp(AbstractBuild build, Launcher launcher, BuildListener l
  /**
  * Copy the provisioning profiles configured for this job to the mobile provisioning profile path of the node or master, where the job is executed.
  * @param build current build
- * @throws IOException
- * @throws InterruptedException 
  */
  private void copyProvisioningProfiles(AbstractBuild build) throws IOException, InterruptedException {
 
- Hudson hudson = Hudson.getInstance();
- FilePath hudsonRoot = hudson.getRootPath();
+ Jenkins jenkins = Jenkins.get();
+ FilePath hudsonRoot = jenkins.getRootPath();
  VirtualChannel channel;
  String toProvisioningProfilesDirectoryPath = null;
 
@@ -235,4 +235,3 @@ public boolean tearDown(AbstractBuild build, BuildListener listener)
  }
 
 }
-

src/main/java/com/sic/plugins/kpp/model/KPPCertificate.java

@@ -55,7 +55,6 @@ public String getCodeSigningIdentityName() {
 
  /**
  * Set the code singing identity name.
- * @param codeSigningIdentityName 
  */
  public void setCodeSigningIdentityName(String codeSigningIdentityName) {
  this.codeSigningIdentityName = codeSigningIdentityName;

src/main/java/com/sic/plugins/kpp/model/KPPKeychain.java

@@ -32,6 +32,8 @@
 import hudson.util.Secret;
 import java.io.Serializable;
 import java.util.List;
+
+import jenkins.model.Jenkins;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 /**
@@ -114,7 +116,6 @@ public final String getDescription() {
 
  /**
  * Set description.
- * @param description 
  */
  public final void setDescription(String description) {
  this.description = description;
@@ -163,7 +164,7 @@ public int hashCode() {
  * @return descriptor
  */
  public Descriptor getDescriptor() {
- Descriptor ds = Hudson.getInstance().getDescriptorOrDie(getClass());
+ Descriptor ds = Jenkins.get().getDescriptorOrDie(getClass());
  return ds;
  }
 
@@ -178,4 +179,4 @@ public String getDisplayName() {
  return Messages.KPPKeychain_DisplayName();
  }
  }
-}
+}

src/main/java/com/sic/plugins/kpp/model/KPPKeychainCertificatePair.java

@@ -161,7 +161,6 @@ public String getKeychainFileName() {
 
  /**
  * Get the keychain from a given string. The string has to start with the keychain filename.
- * @param keychainString
  * @return keychain
  */
  public static KPPKeychain getKeychainFromString(String keychainString) {
@@ -186,7 +185,6 @@ public static KPPKeychain getKeychainFromString(String keychainString) {
 
  /**
  * Concatenation keychain filename and keychain description in one string.
- * @param k
  * @return concatenated keychain string
  */
  private static String getKeychainString(KPPKeychain k) {

src/main/java/com/sic/plugins/kpp/model/KPPProvisioningProfile.java

@@ -34,6 +34,9 @@
 import java.io.File;
 import java.io.Serializable;
 import java.util.List;
+import java.util.Objects;
+
+import jenkins.model.Jenkins;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.QueryParameter;
 
@@ -136,7 +139,7 @@ public boolean equals(Object obj) {
  return false;
  }
  final KPPProvisioningProfile other = (KPPProvisioningProfile) obj;
- if ((this.fileName == null) ? (other.fileName != null) : !this.fileName.equals(other.fileName)) {
+ if (!Objects.equals(this.fileName, other.fileName)) {
  return false;
  }
  return true;
@@ -154,7 +157,7 @@ public int hashCode() {
  * @return descriptor
  */
  public Descriptor<KPPProvisioningProfile> getDescriptor() {
- Descriptor ds = Hudson.getInstance().getDescriptorOrDie(getClass());
+ Descriptor ds = Jenkins.get().getDescriptorOrDie(getClass());
  return ds;
  }
 

src/main/java/com/sic/plugins/kpp/provider/KPPBaseKeychainsProvider.java

@@ -103,7 +103,6 @@ public static ExtensionList<KPPBaseKeychainsProvider> all() {
  /**
  * Call this method to update keychains from save action. The keychains from save action are merged into current keychains list. 
  * Then this list is sychnronized with the upload folder.
- * @param keychainsAfterSave 
  */
  public void updateKeychainsFromSave(List<KPPKeychain>keychainsFromSave) {
  List<KPPKeychain> ksCurrent = new ArrayList<KPPKeychain>(getKeychains());
@@ -134,7 +133,6 @@ public void updateKeychainsFromSave(List<KPPKeychain>keychainsFromSave) {
 
  /**
  * Checks if a given file item is a keychain file.
- * @param item
  * @return true, if it is a keychain file.
  */
  public boolean isKeychainFile(FileItem item) {

src/main/java/com/sic/plugins/kpp/provider/KPPBaseProvider.java

@@ -99,9 +99,6 @@ public String getUploadDirectoryPath() {
 
  /**
  * Store uploaded file inside upload directory.
- * @param fileItemToUpload
- * @throws FileNotFoundException
- * @throws IOException 
  */
  public void upload(FileItem fileItemToUpload) throws FileNotFoundException, IOException {
  // save uploaded file
@@ -129,7 +126,6 @@ public String getConfigXmlFileName() {
 
  /**
  * Save provider config xml.
- * @throws IOException 
  */
  public final void save() {
  try {