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

Use java.nio to load filter files #2684

Merged
merged 3 commits into from
Nov 11, 2023
Merged
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Currently the versioning policy of this project follows [Semantic Versioning v2.

### Fixed
- Fixed false positive UPM_UNCALLED_PRIVATE_METHOD for method used in JUnit's MethodSource ([[#2379](https://github.com/spotbugs/spotbugs/issues/2379)])
- Use java.nio to load filter files ([[#2684](https://github.com/spotbugs/spotbugs/pull/2684)])
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are you sure, you wanted to refer the PR here and not the fixed issue?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The issue in the IntelliJ plugin, since Jetbrains does not seem to be actively maintaining it I think it will take a while until the plugin gets the updated version

Copy link
Collaborator

Choose a reason for hiding this comment

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

In this exact instance, I get it. However, I couldn't find the general logic yet, when exactly is referenced the issue, and when the PR, when there are no links? The links seems the same, when looking at the preview of the file (not the raw version), which may be a bit confusing for the reader. Until this point, I only refered the fixed issues. Could you please clarify this to me? (It's a bit off topic here, sorry about it.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't know either to be honest, but as a user I would expect a link to something giving some context as to what was changed and why


- tbd

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/*
* Contributions to SpotBugs
* Copyright (C) 2023, the SpotBugs authors
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package edu.umd.cs.findbugs.filter;

import static org.junit.jupiter.api.Assertions.fail;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;


import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;


/**
* @author gtoison
*/
class Utf8FilterFileNameTest {
@TempDir
private Path folderPath;

@Test
void loadFilter() {
Path filterPath = folderPath.resolve("äéàùçæð.xml");

try {
Files.createFile(filterPath);
Files.writeString(filterPath, "<FindBugsFilter/>");

Filter filter = new Filter(filterPath.toAbsolutePath().toString());
} catch (IOException e) {
fail("Error loading filter file " + filterPath, e);
}
}
}
7 changes: 5 additions & 2 deletions spotbugs/src/main/java/edu/umd/cs/findbugs/filter/Filter.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@
package edu.umd.cs.findbugs.filter;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Reader;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.IdentityHashMap;
import java.util.Iterator;

Expand Down Expand Up @@ -204,7 +206,8 @@ public boolean match(BugInstance bugInstance) {
* @throws ParserConfigurationException
*/
private void parse(String fileName) throws IOException, SAXException, ParserConfigurationException {
FileInputStream fileInputStream = new FileInputStream(new File(fileName));
Path path = FileSystems.getDefault().getPath(fileName);
InputStream fileInputStream = Files.newInputStream(path);
parse(fileName, fileInputStream);
}

Expand Down