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

[MENFORCER-390] "requireFilesExist" no longer handles non-canonical paths #297

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

roadSurfer
Copy link

@roadSurfer roadSurfer commented Nov 24, 2023

This reverts the change from MENFORCER-364 as this led to a regressions with symbolic links.

The fundamental issue is that there is no clean way to deal with case-sensitivity as OSs can have multuple filesystems mounted that follow different rules. Thus the simple file.exists() is, despite the limitations, probably best. Those requiring more stringent checks writing their own handling.

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [MENFORCER-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace MENFORCER-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the
    commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean verify to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its clean verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

@slawekjaranowski
Copy link
Member

Ok, the simple file.exists() should be enough in normal usage ...

I only think - if we don't break and special cases ... but agree more complicated check should be done optionally or by next rule

By the way we can mention in documentation a way how file existence is checked to be clear.

@roadSurfer
Copy link
Author

I have added some words to the affected documentation on case-sensitivity, as well as some explic testing of symbolic links.

@Torbjorn-Svensson
Copy link

Are all the white space changes in the .md files intended?
As far as I know, some of the trailing white spaces are needed in order to not join the lines.

@roadSurfer
Copy link
Author

roadSurfer commented Nov 27, 2023 via email

@roadSurfer
Copy link
Author

That should be the whitepsace issues sorted. I also generated the site locally and it appeared OK to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants