Brauche Hilfe bei RegEx

HeinrichG · 6. März 2023

Hallo zusammen,

ich bin dabei einen Git pre-commit Hook zu basteln und brauche etwas Hilfe. Der Hook an sich wird gerufen und "funktioniert".

Das Ding überprüft die Namen der Objekte, die commitet werden sollen, ob sie nur zulässige Zeichen beinhalten.

Die zulässigen Zeichen sind:

A-Z
a-z
0-9
- und _
diese Zeichen könnten drin sein, sind aber "optional" so zu sagen [, ], (, und )

Mein Hook sieht bis jetzt so aus, ich überprüfe im Moment nur auf Leerzeichen (regex1 im Code):

Code

#!C:/Program\ Files/Git/usr/bin/sh.exe

# Called by "git commit" with no arguments.  The hook should
# exit with non-zero status after issuing an appropriate message if
# it wants to stop the commit.

# def comparison target
if git rev-parse --verify HEAD >/dev/null 2>&1
then
    against=HEAD
else
    # Initial commit: diff against an empty tree object
    against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
fi

# Redirect output to stderr.
exec 1>&2

IFS=$'\n'
## [[:blank:]] means space and tab. This makes it similar to: [ \t].
## [[:space:]], in addition to space and tab, includes newline, linefeed, formfeed, and vertical tab. This makes it similar to: [ \t\n\r\f\v]

teststring1="SLDWH-2086_Umsetzung_FiBu_Nebenbuch_Kontokorrent_(Kontokorrentkonto)"
teststring2="SLDWH-2082_Korrektur_ODI_Loadplans"

regex1="[[:space:]]+"

# Abort a commit if you have non ASCII characters in
# the commit, and output the non ASCII characters.
echo "Checking for unicode characters and trailing whitespace"

listchange=$(git diff --staged --name-only $against)

echo "Check filenames, check 1:"

for filename in $listchange 
do
    fname=$(basename $filename)
    if [[ $fname =~ $regex1 ]]; then 
        echo "$fname match";
    else
        echo "$fname didn't match!";
    fi
done

exit 1

Alles anzeigen

Die Variablen teststring1 und teststring2 sind Beispiele dafür, wie ein Objekten heißen kann.

Wäre jemand so nett die RegEx zu schreiben, ich scheitere gnadenlos dran...

Vielen Dank im Voraus!

H6G · 6. März 2023

Zitat von HeinrichG

"optional"

Ist der Rest nicht optional, also müssen die Zeichen vorkommen - sind also nicht zulässig, sondern verpflichtend?

HeinrichG · 6. März 2023

Der Rest ist erfahrungsgemäß immer drin, nur diese optionale Zeichen könnten zusätzlich vorkommen.

Siehe die beiden teststrings, teststring2 ist entspricht so ca 95% der Namen, teststring1 ist dann 5%.

Man könnte auch so sagen: wenn NUR diese ausgelisteten Zeichen drin sind, dann ist alles super und es darf commitet werden.

m_ueberall · 6. März 2023

Nach Austausch der ersten Zeile sollte das hier funktionieren, wenn C:/Program\ Files/Git/usr/bin/sh.exe POSIX-konform ist:

Code

#! /bin/bash

filename="$1"

fname="$(basename "$filename")"
if [[ "$fname" =~ ^[\]\[\)\(0-9A-Za-z_\-]+$ ]]; then 
    echo "$fname match (valid)";
else
    echo "$fname didn't match (invalid)!";
fi

Der Trick besteht in der korrekten Reihenfolge der Sonderzeichen ']' und '-', ansonsten kann man sich auf den Kopf stellen und nichts funktioniert (siehe hier).

HeinrichG · 6. März 2023

Ich hab den Hook jetzt mal etwas umgebaut:

Code

#!C:/Program\ Files/Git/usr/bin/sh.exe

# Called by "git commit" with no arguments.  The hook should
# exit with non-zero status after issuing an appropriate message if
# it wants to stop the commit.

# def comparison target
if git rev-parse --verify HEAD >/dev/null 2>&1
then
    against=HEAD
else
    # Initial commit: diff against an empty tree object
    against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
fi

# Redirect output to stderr.
exec 1>&2

IFS=$'\n'
## [[:blank:]] means space and tab. This makes it similar to: [ \t].
## [[:space:]], in addition to space and tab, includes newline, linefeed, formfeed, and vertical tab. This makes it similar to: [ \t\n\r\f\v]

teststring1="SLDWH-2086_Umsetzung_FiBu_Nebenbuch_Kontokorrent_(Kontokorrentkonto)"
teststring2="SLDWH-2082_Korrektur_ODI_Loadplans"

regex1="[[:space:]]+"

# Abort a commit if you have non ASCII characters in
# the commit, and output the non ASCII characters.
echo "Checking for unicode characters and trailing whitespace"

listchange=$(git diff --staged --name-only $against)

echo "Commit list:"
echo $listchange

echo "Check filenames, check 1:"

echo "-----------------------------------------------------------------"

for filename in $listchange 
do
    
    fname=$(basename $filename)
    echo "Full name: $filename"
    echo "File name: $fname"
    
    if [[ "$filename" =~ ^[\]\[\)\(0-9A-Za-z_\-]+$ ]]; then 
        echo "$filename match (valid)";
    else
        echo "$filename didn't match (invalid)!";
    fi
    
    if [[ "$fname" =~ ^[\]\[\)\(0-9A-Za-z_\-]+$ ]]; then 
        echo "$fname match (valid)";
    else
        echo "$fname didn't match (invalid)!";
    fi
    
    echo "-----------------------------------------------------------------"
done

exit 1

Alles anzeigen

Mein Verzeichnis mit Zeug sieht so aus:

pasted-from-clipboard.png

In den Verzeichnissen ist jeweils eine Datei drin.

Es sollen beide Verzeichnisse und jeweiligen Dateien commitet werden:

Ausgabe vom Hook:

pasted-from-clipboard.png

Irgendwas gefällt ihm noch nicht so...

m_ueberall · 6. März 2023

Zitat von HeinrichG

Irgendwas gefällt ihm noch nicht so...

In Zeile 48 wird ja zunächst immer die vollständige Pfadangabe verglichen (warum?), welche ein laut RegEx unzulässiges '/' enthält, deswegen sieht man hier genau zwei Fehlermeldungen aus diesem Block. Der zweite Block funktioniert ebenfalls nicht, weil in der ursprünglichen Liste der gültigen Zeichen kein '.' vorkam; somit wäre der RegEx zu erweitern auf ^[\]\[\)\(0-9A-Za-z_\.\-]+.

Ich würde raten, die Scripts generell mit ShellCheck gegenzuprüfen, welches sich über Zeile 44 beschweren würde (wegen fehlenden Anführungszeichen). Wenn ein Verzeichnis oder eine Datei ein Leerzeichen enthält, bekommt basename hier automatisch zwei Argumente und das Ergebnis ist sicherlich nicht das gewünschte.

HeinrichG · 6. März 2023

Hallo,

in den Zeilen 48 bis 52 wird der gesamte Pfad geprüft, dass hier ein Fehler auftritt ist völlig okay und erwartet. Die Verzeinisse gehören ja auch zum Commit und sollten auch überprüft werden. Das ist mir erst gerade klar geworden, sorry. Also der komplette Pfad (Verzeichnis und Dateiname) soll geprüft werden. Im Skript heißt die Variable filename.

In den Zeilen 54 bis 58 findet die Prüfung der Filenamen statt, da sollte aber nicht zu Fehlern kommen.

m_ueberall · 6. März 2023

Siehe meine gerade editierte Antwort oben.

HeinrichG · 6. März 2023

Danke Dir für den Link zum ShellCheck, das kannte ich noch nicht.

Also, die aktuelle Version:

Code

#!C:/Program\ Files/Git/usr/bin/sh.exe

# Called by "git commit" with no arguments.  The hook should
# exit with non-zero status after issuing an appropriate message if
# it wants to stop the commit.

# def comparison target
if git rev-parse --verify HEAD >/dev/null 2>&1
then
    against=HEAD
else
    # Initial commit: diff against an empty tree object
    against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
fi

# Redirect output to stderr.
exec 1>&2

IFS=$'\n'
## [[:blank:]] means space and tab. This makes it similar to: [ \t].
## [[:space:]], in addition to space and tab, includes newline, linefeed, formfeed, and vertical tab. This makes it similar to: [ \t\n\r\f\v]

teststring1="SLDWH-2086_Umsetzung_FiBu_Nebenbuch_Kontokorrent_(Kontokorrentkonto)"
teststring2="SLDWH-2082_Korrektur_ODI_Loadplans"

regex1="[[:space:]]+"

# Abort a commit if you have non ASCII characters in
# the commit, and output the non ASCII characters.
echo "Checking for unicode characters and trailing whitespace"

listchange=$(git diff --staged --name-only $against)

echo "Commit list:"
echo $listchange

echo "Check filenames, check 1:"

echo "-----------------------------------------------------------------"

for filename in $listchange 
do
    echo "Full name: $filename"
    
    if [[ "$filename" =~ ^[\]\[\)\(0-9A-Za-z_\.\-]+$ ]]; then 
        echo "$filename match (valid)";
    else
        echo "$filename didn't match (invalid)!";
    fi
    
    echo "-----------------------------------------------------------------"
done

exit 1

Alles anzeigen

Habe die Prüfung der Dateien rangenommen und nur noch die Prüfung der Pfade drin gelassen.

Ausgabe:

pasted-from-clipboard.png

m_ueberall · 6. März 2023

Also wie erwartet, weil im oberen, nunmehr einzigen Block im RegEx immer noch das '/' fehlt (der Ausdruck ^[\]\[\)\(0-9A-Za-z_/\.\-]+$, mit oder ohne Dollarzeichen am Ende, würde die übergebenen Pfade als valide akzeptieren).

HeinrichG · 6. März 2023

Ich habe noch zwei Testfälle hinzugefügt, einmal mir einem SPACE im Verzeichnispfad und einmal mit SPACEs im Dateinamen und es ist perfekt!

pasted-from-clipboard.png

Ich danke Dir vielmals für die super Hilfe!