Added plugin information while using verbose #611

AayushSaini101 · 2023-11-12T12:44:16Z

Fixes #610

Submitter checklist

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests - that demonstrates feature works or fixes the issue

MarkEWaite

Thanks for the pull request! Some items for clarification and the spotbugs suppression needs to be fixed.

Can you add a test that confirms the new output is being generated?

MarkEWaite · 2023-11-12T16:58:12Z

plugin-management-cli/src/main/java/io/jenkins/tools/pluginmanager/cli/CliOptions.java

@@ -269,11 +269,14 @@ private String getJenkinsWar() {
     *
     * @return list of plugins representing user-specified input
     */
+
+   @SuppressFBWarnings(value = {"PATH_TRAVERSAL_IN", "URLCONNECTION_SSRF_FD"}, justification = "User provided values for running the program.")


No need to suppress a warning that does not exist in this context.

Suggested change

@SuppressFBWarnings(value = {"PATH_TRAVERSAL_IN", "URLCONNECTION_SSRF_FD"}, justification = "User provided values for running the program.")

@SuppressFBWarnings(value = "PATH_TRAVERSAL_IN", justification = "User provided values for running the program.")

Done @MarkEWaite

MarkEWaite · 2023-11-12T17:02:12Z

plugin-management-cli/src/main/java/io/jenkins/tools/pluginmanager/cli/CliOptions.java

+         File[] directoryListing = dr.listFiles();
+            if (directoryListing != null) {
+                for (File child : directoryListing) {
+                    pluginNames.add(child.getName());


This will add many unnecessary items to the list when run in a Jenkins plugins folder that is used by a running Jenkins controller. I think it would be better to only add the child if it is a plain file (not a directory) and does not have one of the suffixes (".bak", ".pinned", or ".version_from_image").

Suggested change

pluginNames.add(child.getName());

pluginNames.add(child.getName());

Done @MarkEWaite

MarkEWaite · 2023-11-12T17:03:00Z

plugin-management-cli/src/main/java/io/jenkins/tools/pluginmanager/cli/CliOptions.java

@@ -283,7 +286,27 @@ private List<Plugin> getPlugins() {
                throw new PluginInputException("Unknown file type, file must have .yaml/.yml or .txt extension");
            }
        }
-        return requestedPlugins;
+         List<String> pluginNames = new ArrayList<>();


This seems like it is generating a list of plugin file names rather than plugin names. Would it be better to rename the variable pluginFileNames for clarity?

Suggested change

List<String> pluginNames = new ArrayList<>();

List<String> pluginNames = new ArrayList<>();

Done @MarkEWaite

MarkEWaite · 2023-11-12T17:03:59Z

plugin-management-cli/src/test/java/io/jenkins/tools/pluginmanager/cli/CliOptionsTest.java

@@ -216,7 +216,6 @@ public void setupUpdateCenterCliTest() throws Exception {
        assertThat(cfg.getJenkinsIncrementalsRepoMirror()).hasToString(incrementalsCli);
        assertThat(cfg.getJenkinsPluginInfo()).hasToString(pluginInfoCli);
    }
-


I would prefer that you not remove the empty line between tests. I makes it more difficult for me to read. In this case, it seems that is the only change in this file in this pull request, so it should be removed from the pull request.

Done @MarkEWaite

AayushSaini101 · 2023-11-13T17:00:09Z

Thanks @MarkEWaite I have one doubt, How can i compare the logs of --verbose for the test cases. I need to test whether the log containing particular statement or not that concludes the plugin is already present or not

MarkEWaite · 2023-11-13T17:25:30Z

Thanks @MarkEWaite I have one doubt, How can i compare the logs of --verbose for the test cases. I need to test whether the log containing particular statement or not that concludes the plugin is already present or not

I would search the existing tests in the repository to see if any of them are already testing the output. If such a test already exists, then I'd copy its source code into a new test and adapt the new test to check the new behavior.

plugin-management-cli/src/test/java/io/jenkins/tools/pluginmanager/cli/CliOptionsTest.java looks like a good place to start

AayushSaini101 · 2023-11-14T06:03:58Z

Thanks @MarkEWaite I have one doubt, How can i compare the logs of --verbose for the test cases. I need to test whether the log containing particular statement or not that concludes the plugin is already present or not

I would search the existing tests in the repository to see if any of them are already testing the output. If such a test already exists, then I'd copy its source code into a new test and adapt the new test to check the new behavior.

plugin-management-cli/src/test/java/io/jenkins/tools/pluginmanager/cli/CliOptionsTest.java looks like a good place to start

Thanks @MarkEWaite

MarkEWaite · 2023-11-29T00:21:02Z

plugin-management-cli/src/main/java/io/jenkins/tools/pluginmanager/cli/CliOptions.java

-        return requestedPlugins;
+         List<String> pluginFileNames = new ArrayList<>();
+
+         File dr = new File(String.valueOf(pluginDir));


That seems like a very complicated technique to get a File (dr) from an existing File (pluginDir). I think it would be better to use pluginDir directly rather than convert pluginDir to a string then use that string to create a new File.

Note that this suggestion won't compile. You should rework the change to use pluginDir instead of dr.

Suggested change

File dr = new File(String.valueOf(pluginDir));

MarkEWaite · 2023-11-29T00:21:42Z

plugin-management-cli/src/main/java/io/jenkins/tools/pluginmanager/cli/CliOptions.java

    private List<Plugin> getPlugins() {
        PluginListParser pluginParser = new PluginListParser(verbose);
        List<Plugin> requestedPlugins = new ArrayList<>(pluginParser.parsePluginsFromCliOption(plugins));

        File pluginFile = getPluginFile();
+


I don't understand the benefit of adding this empty line. It makes more work for reviewers. I think it should be removed.

Suggested change

MarkEWaite · 2023-11-29T00:23:13Z

plugin-management-cli/src/main/java/io/jenkins/tools/pluginmanager/cli/CliOptions.java

@@ -283,7 +286,29 @@ private List<Plugin> getPlugins() {
                throw new PluginInputException("Unknown file type, file must have .yaml/.yml or .txt extension");
            }
        }
-        return requestedPlugins;
+         List<String> pluginFileNames = new ArrayList<>();


Please use formatting that is consistent with the rest of the file. The preceding line uses 8 leading spaces yet you chose to use 9 leading spaces. That makes the code review and future changes more difficult because people reading the code wonder why the formatting changed in the middle of the file.

Suggested change

List<String> pluginFileNames = new ArrayList<>();

List<String> pluginFileNames = new ArrayList<>();

MarkEWaite · 2023-11-29T00:24:00Z

plugin-management-cli/src/main/java/io/jenkins/tools/pluginmanager/cli/CliOptions.java

+
+         File dr = new File(String.valueOf(pluginDir));
+
+         File[] directoryListing = dr.listFiles();


Don't need to use dr when we already have pluginDir

Suggested change

File[] directoryListing = dr.listFiles();

File[] directoryListing = pluginDir.listFiles();

MarkEWaite · 2023-11-29T00:30:00Z

plugin-management-cli/src/main/java/io/jenkins/tools/pluginmanager/cli/CliOptions.java

@@ -269,11 +269,14 @@ private String getJenkinsWar() {
     *
     * @return list of plugins representing user-specified input
     */
+


The other suppress entry in this file does not insert a blank line before the suppression. I think it would be best to not insert this blank line. Let's keep the formatting consistent when we can.

Suggested change

MarkEWaite · 2023-11-29T00:30:23Z

plugin-management-cli/src/main/java/io/jenkins/tools/pluginmanager/cli/CliOptions.java

+         for(Plugin plugin: requestedPlugins){
+
+            for(String names:pluginFileNames) {
+                if (names.contains(plugin.getName())) {


I believe that this will give an incorrect verbose log entry when an existing plugin name is a substring of another plugin name. For example, if the plugin jquery3-api is already installed and the plugin jquery is requested, then I think that this will report that jquery is already present in the directory, even though it is not already present.

I don't have an immediate suggestion of how to resolve that issue, but here is a set of steps that I use to duplicate the issue:

mvn clean -DskipTests verify rm -rf ../plugins mkdir ../plugins echo jquery > ../plugins.txt java -jar plugin-management-cli/target/jenkins-plugin-manager-*.jar --verbose --war ~/bugs/jenkins-2.431.war --plugin-download-directory ../plugins/ --plugin-file ../plugins.txt --plugins delivery-pipeline-plugin:1.3.2 deployit-plugin > ../stdout 2> ../stderr rm -rf ../plugins/jquery.jpi java -jar plugin-management-cli/target/jenkins-plugin-manager-*.jar --verbose --war ~/bugs/jenkins-2.431.war --plugin-download-directory ../plugins/ --plugin-file ../plugins.txt --plugins delivery-pipeline-plugin:1.3.2 deployit-plugin > ../stdout 2> ../stderr grep jquery ../stderr

MarkEWaite · 2023-11-29T00:37:08Z

...n-management-library/src/main/java/io/jenkins/tools/pluginmanager/util/PluginListParser.java

+
+

Please don't add empty lines in unrelated files. It makes the review more difficult and does not help future reviewer.

Suggested change

MarkEWaite · 2023-11-29T00:37:34Z

plugin-management-cli/src/test/java/io/jenkins/tools/pluginmanager/cli/CliOptionsTest.java

@@ -41,6 +41,7 @@ public class CliOptionsTest {
    @Rule
    public TemporaryFolder temporaryFolder = new TemporaryFolder();

+


I don't see the benefit of this empty line.

Suggested change

MarkEWaite · 2023-11-29T00:48:46Z

plugin-management-cli/src/test/java/io/jenkins/tools/pluginmanager/cli/CliOptionsTest.java

+        String stdOut = tapSystemOutNormalized(() -> {
+               Config cfg = options.setup();
+        });
+
+        assertThat(stdOut).isEmpty();


This needs to assert the contents of stderr (where the verbose log is written) rather than the contents of stdout.

See the earlier examples in the file for the technique to check the contents of stderr.

Added plugin information while using verbose

6956132

MarkEWaite requested changes Nov 12, 2023

View reviewed changes

Improve naming convention and added test cases

cad3fd8

Resolve checkstyle issue

8aa5303

MarkEWaite requested changes Nov 29, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added plugin information while using verbose #611

Added plugin information while using verbose #611

AayushSaini101 commented Nov 12, 2023 •

edited by MarkEWaite

MarkEWaite left a comment •

edited

MarkEWaite Nov 12, 2023

AayushSaini101 Nov 14, 2023

MarkEWaite Nov 12, 2023

AayushSaini101 Nov 14, 2023

MarkEWaite Nov 12, 2023

AayushSaini101 Nov 14, 2023

MarkEWaite Nov 12, 2023

AayushSaini101 Nov 14, 2023

AayushSaini101 commented Nov 13, 2023

MarkEWaite commented Nov 13, 2023

AayushSaini101 commented Nov 14, 2023

MarkEWaite Nov 29, 2023

MarkEWaite Nov 29, 2023

MarkEWaite Nov 29, 2023

MarkEWaite Nov 29, 2023

MarkEWaite Nov 29, 2023

MarkEWaite Nov 29, 2023

MarkEWaite Nov 29, 2023

MarkEWaite Nov 29, 2023

MarkEWaite Nov 29, 2023

	@SuppressFBWarnings(value = {"PATH_TRAVERSAL_IN", "URLCONNECTION_SSRF_FD"}, justification = "User provided values for running the program.")
	@SuppressFBWarnings(value = "PATH_TRAVERSAL_IN", justification = "User provided values for running the program.")

	pluginNames.add(child.getName());
	pluginNames.add(child.getName());

	List<String> pluginNames = new ArrayList<>();
	List<String> pluginNames = new ArrayList<>();

	List<String> pluginFileNames = new ArrayList<>();
	List<String> pluginFileNames = new ArrayList<>();


		File dr = new File(String.valueOf(pluginDir));

		File[] directoryListing = dr.listFiles();

	File[] directoryListing = dr.listFiles();
	File[] directoryListing = pluginDir.listFiles();

		@@ -41,6 +41,7 @@ public class CliOptionsTest {
		@Rule
		public TemporaryFolder temporaryFolder = new TemporaryFolder();

Added plugin information while using verbose #611

Are you sure you want to change the base?

Added plugin information while using verbose #611

Conversation

AayushSaini101 commented Nov 12, 2023 • edited by MarkEWaite

MarkEWaite left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AayushSaini101 commented Nov 13, 2023

MarkEWaite commented Nov 13, 2023

AayushSaini101 commented Nov 14, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AayushSaini101 commented Nov 12, 2023 •

edited by MarkEWaite

MarkEWaite left a comment •

edited