#!/bin/bash #============================================================================== # Copyright and license info is available in the LICENSE file included with # the Server Deployment Package (SDP), and also available online: # https://swarm.workshop.perforce.com/projects/perforce-software-sdp/view/main/LICENSE #------------------------------------------------------------------------------ #============================================================================== # Declarations and Environment export SDP_ENV=/p4/common/bin/p4_vars export SDP_INSTANCE=${SDP_INSTANCE:-Unset} declare StatusMessage="OK: All scanned depots verified OK." declare ThisScript=${0##*} declare Version=5.3.1 declare CmdLine="$0 $*" declare -i VerifyOnlyRecentChanges=0 declare -i VerifyFailed= declare -i ShowLog=0 declare -i ExitCode=0 declare -i VerifyArchived=0 declare -i VerifyShelved=1 declare -i VerifySpecDepot=1 declare -i VerifySubmitted=1 declare -i VerifyUnload=1 declare -i ShelvedCLCount=0 declare -i ShelvedCLErrorCount=0 declare RevRange= declare RecentChangesToVerify=200 declare VerifyCmd= declare ChangesCmd= declare ShelvedChangesToVerify= declare ShelvedCL= declare Log=Unset declare TmpFile= #============================================================================== # Local Functions # Micro-functions, one-liners used to avoid external dependencies. function msg () { if [[ $Log != Unset ]]; then echo -e "$*" >> $Log; else echo -e "$*"; fi; } function bail () { msg "\\nError: ${1:-Unknown Error}"; exit "${2:-1}"; } #------------------------------------------------------------------------------ # Function: usage (required function) # # Input: # $1 - style, either -h (for short form) or -man (for man-page like format). # The default is -h. # # $2 - error message (optional). Specify this if usage() is called due to # user error, in which case the given message displayed first, followed by the # standard usage message (short or long depending on $1). If displaying an # errror, usually $1 should be -h so that the longer usage message doesn't # obsure the error message. # # Sample Usage: # usage # usage -man # usage -h "Incorrect command line usage." # # This last example generates a usage error message followed by the short # '-h' usage summary. #------------------------------------------------------------------------------ function usage { declare style=${1:--h} declare errorMessage=${2:-Unset} if [[ $errorMessage != Unset ]]; then echo -e "\\n\\nUsage Error:\\n\\n$errorMessage\\n\\n" >&2 fi # tag::includeManual[] - required for AsciiDoc echo "USAGE for $ThisScript v$Version: p4verify.sh [<instance>] [-nu] [-nr] [-ns] [-nS] [-a] [-recent] [-L <log>] [-v] [-D] or p4verify.sh -h|-man " if [[ $style == -man ]]; then echo -e "DESCRIPTION: This script performs a 'p4 verify' of all submitted and shelved versioned files in depots of all types except 'remote' and 'archive' type depots. If run on a replica, it schedules archive failures for transfer to the replica. OPTIONS: <instance> Specify the SDP instances. If not specified, the SDP_INSTANCE environment variable is used instead. If the instance is not defined by a parameter and SDP_INSTANCE is not defined, p4verify.sh exists immediately with an error message. -nu Specify '-nu' (No Unload) to skip verification of the singleton depot of type 'unload' (if created). The 'unload' depot is verified by default. -nr Specify '-nr' (No Regular) to skip verification of regular submitted archive files. The '-nr' option is not compatible with '-recent'. Regular submitted archive files are verified by default. -ns Specify '-ns' (No Spec Depot) to skip verification of singleton depot of type 'spec' (if created). The 'spec' depot is verified by default. -nS Specify '-nS' (No Shelves) to skip verification of shelved archive files, i.e. to skip the 'p4 verify -qS'. -a Specify '-a' (Archive Depots) to do verification of depots of type 'archive'. Depots of type 'archive' are not verified by default, as archive depots are often physicially removed from the server's storage subsystem for long-term cold storage. -recent Specify that only recent changelists should be verified. The \$SDP_RECENT_CHANGES_TO_VERIFY variable defines how many changelists are considered recent; the default is $RecentChangesToVerify. If the default is not appropriate for your site, add \"export SDP_RECENT_CHANGES_TO_VERIFY\" to /p4/common/config/p4_N.vars to change the default for an instance, or to /p4/common/bin/p4_vars to change it globally. If \$SDP_RECENT_CHANGES_TO_VERIFY is unset, the default is $RecentChangesToVerify. When -recent is used, neither shelves nor files in the unload depot are verified. -v Verbose. Show output of verify attempts, which is suppressed by default. Setting SDP_SHOW_LOG=1 in the shell environment has the same effect as -v. The default behavior of this script is to generate no terminal outpout, but instead to write output into a log file -- see LOGGING below. If '-v' is specified, the generated log is sent to stdout at the end of processing. This flag is not recommended for routine cron operation or for large data sets. -L <log> Specify the log file to use. The default is /p4/N/logs/p4verify.log Log rotation and old log cleanup logic does not apply to log files specified with -L. Thus, using -L is not recommended for routine scheduled operation, e.g. via crontab. -D Set extreme debugging verbosity. HELP OPTIONS: -h Display short help message -man Display man-style help message EXAMPLES: This script is typically called via cron with only the instance parameter as an argument, e.g.: p4verify.sh N LOGGING: This script generates no output by default. All (stdout and stderr) is logged to /p4/N/logs/p4verify.log. The exception is usage errors, which result an error being sent to stderr followed usage info on stdout, followed by an immediate exit. If the '-v' flag is used, the contents of the log are displayed to stdout at the end of processing. EXIT CODES: An exit code of 0 indicates no errors were encounted attempting to perform verifications, AND that all verifications attempted reported no problems. A exit status of 1 indicates that verifications could not be attempted for some reason. A exit status of 2 indicates that verifications were successfully performed, but that problems such as BAD or MISSING files were detected, or else system limits prevented verification. " # end::includeManual[] - required for AsciiDoc fi exit 1 } #------------------------------------------------------------------------------ # Function: get_verify_rev_range ($depot, $recentChanges) #------------------------------------------------------------------------------ function get_verify_rev_range () { declare depot=${1:-} declare recentChangesToVerify=${2:-} declare nowChange= [[ -z "$depot" || -z "$recentChangesToVerify" ]] && return 0 nowChange=$("$P4BIN" -ztag -F %change% changes -m 1 "//$depot/...") thenChange=$("$P4BIN" -ztag -F %change% changes -m "$recentChangesToVerify" "//$depot/..." | tail -1) [[ -z "$nowChange" ]] && return 1 [[ -z "$thenChange" ]] && return 1 echo "@$thenChange,@$nowChange" return 0 } #============================================================================== # Command Line Processing declare -i shiftArgs=0 set +u while [[ $# -gt 0 ]]; do case "$1" in (-h) usage -h;; (-man) usage -man;; (-ns) VerifySpecDepot=0;; (-nS) VerifyShelved=0;; (-nr) VerifySubmitted=0;; (-nu) VerifyUnload=0;; (-recent) VerifyOnlyRecentChanges=1;; (-v) ShowLog=1;; (-L) Log=$2; shiftArgs=1;; (-D) set -x;; # Debug; use 'set -x' mode. (-*) usage -h "Unknown command line option ($1).";; (*) export SDP_INSTANCE=$1;; esac # Shift (modify $#) the appropriate number of times. shift; while [[ $shiftArgs -gt 0 ]]; do [[ $# -eq 0 ]] && usage -h "Incorrect number of arguments." shiftArgs=$shiftArgs-1 shift done done set -u #============================================================================== # Command Line Verification [[ $SDP_INSTANCE == Unset ]] && \ bail "The \\$SDP_INSTANCE setting is not defined. It must be defined by doing:\\n\\n\\tsource /p4/common/bin/p4_vars <instance>\\n\\nor by passing in the instance name as a parameter to this script.\\n" [[ "$VerifySubmitted" -eq 0 && "$VerifyOnlyRecentChanges" -eq 1 ]] && \ bail "The '-recent' and '-nr' options are mutually exclusive." #============================================================================== # Main Program # shellcheck disable=SC1090 source "$SDP_ENV" "$SDP_INSTANCE" ||\ bail "Failed to load SDP environment for instance $SDP_INSTANCE." # shellcheck disable=SC1090 source "$P4CBIN/backup_functions.sh" ||\ bail "Failed to load backup_functions.sh." #------------------------------------------------------------------------------ # Function: cmd() # We need to define cmd() after we have sourced backup_functions.sh. function cmd () { tmpf="${P4TMP}/t_verify.$$.$RANDOM" msg "$*" >> "$Log" # Disable SC2048 for $* because we want any spaces to be expanded here. # shellcheck disable=SC2048 $* > "$tmpf" 2>&1 status=$? # Suppress 'no such file' errors from older p4d versions. In newer p4d # versions, this is a mere warning, which we don't suppress. grep -v "^error: //$d/... - no such file(s)." "$tmpf" >> "$Log" rm -f "$tmpf" return $status } # If $SDP_RECENT_CHANGES_TO_VERIFY, use that, else default to the value set for # $RecentChangesToVerify in this script. [[ -n "${SDP_RECENT_CHANGES_TO_VERIFY:-}" ]] && \ RecentChangesToVerify="${SDP_RECENT_CHANGES_TO_VERIFY}" [[ "$Log" == Unset ]] && Log=$LOGS/p4verify.log # This is needed because everything in backup_functions.sh uses LOGFILE including the mail_log_file function. LOGFILE=$Log rotate_log_file "$LOGFILE" ".gz" msg "Started $ThisScript v$Version as $USER@${HOSTNAME%%.*} on $(date +'%a %Y-%m-%d %H:%M:%S %Z') as:\\n$CmdLine" P4="$P4BIN -p $P4PORT -u $P4USER" "$P4CBIN/p4login" msg "If there are errors in this log, contact support@perforce.com" VerifyFailed=0 if [[ "$VerifyOnlyRecentChanges" -eq 1 ]]; then msg "Info: Verifying only $RecentChangesToVerify changelists per depot due to -recent.\\n" fi RevRange= for d in $($P4 -ztag -F %name% depots); do depotType=$($P4 -ztag -F %Type% depot -o "$d") case "$depotType" in (archive) [[ "$VerifyArchived" -eq 1 ]] || continue if [[ "${P4REPLICA}" == "FALSE" || "${SHAREDDATA}" == "TRUE" ]]; then msg "=== Started verify of archive depot //$d/... at $(date)." VerifyCmd="$P4 -s verify -A -q //$d/..." cmd "$VerifyCmd" || VerifyFailed=1 else msg "=== Started verify of archive depot on replica at $(date)." VerifyCmd="$P4 -s verify -A -q -t //$d/..." cmd "$VerifyCmd" || VerifyFailed=1 fi ;; (remote) msg "\\nInfo: Skipping verify of remote depot $d.\\n" continue ;; (spec) [[ "$VerifySpecDepot" -eq 1 ]] || continue if [[ "${P4REPLICA}" == "FALSE" || "${SHAREDDATA}" == "TRUE" ]]; then msg "=== Started verify of spec depot //$d/... at $(date)." VerifyCmd="$P4 -s verify -qz //$d/..." cmd "$VerifyCmd" || VerifyFailed=1 else msg "=== Started verify of spec depot //$d/... on replica at $(date)." VerifyCmd="$P4 -s verify -qz -t //$d/..." cmd "$VerifyCmd" || VerifyFailed=1 fi ;; (unload) [[ "$VerifyUnload" -eq 1 ]] || continue if [[ "${P4REPLICA}" == "FALSE" || "${SHAREDDATA}" == "TRUE" ]]; then msg "=== Started verify of unload depot at $(date)." VerifyCmd="$P4 -s verify -U -q //$d/..." cmd "$VerifyCmd" || VerifyFailed=1 else msg "=== Started verify of unload depot on replica at $(date)." VerifyCmd="$P4 -s verify -U -q -t //$d/..." cmd "$VerifyCmd" || VerifyFailed=1 fi ;; (*) [[ "$depotType" != "local" && "$depotType" != "stream" ]] && \ msg "Warning: Unknown depot type [$depotType]. Attempting normal verify." if [[ "$VerifyOnlyRecentChanges" -eq 1 ]]; then RevRange=$(get_verify_rev_range "$d" "$RecentChangesToVerify") fi if [[ "${P4REPLICA}" == "FALSE" || "${SHAREDDATA}" == "TRUE" ]]; then if [[ "$VerifySubmitted" -eq 1 ]]; then msg "=== Started verify of submitted files in //$d/... at $(date)." VerifyCmd="$P4 -s verify -qz //$d/...$RevRange" cmd "$VerifyCmd" || VerifyFailed=1 fi else if [[ "$VerifySubmitted" -eq 1 ]]; then msg "=== Started verify of submitted files on replica in //$d/... at $(date)." VerifyCmd="$P4 -s verify -qz -t //$d/...$RevRange" cmd "$VerifyCmd" || VerifyFailed=1 fi fi ;; esac done if [[ "$VerifyShelved" -eq 1 ]]; then msg "=== Started verify of shelved changelists at $(date)." TmpFile=$(mktemp) ChangesCmd="$P4BIN -ztag -F %change% changes -s shelved" [[ "$VerifyOnlyRecentChanges" -eq 1 ]] && \ ChangesCmd+=" -m $RecentChangesToVerify" ShelvedCLCount=0 ShelvedCLErrorCount=0 if $ChangesCmd > "$TmpFile"; then ShelvedChangesToVerify=$(wc -l "$TmpFile" | cut -d ' ' -f 1) msg "Verifying $ShelvedChangesToVerify shelved changelists." while read -r ShelvedCL; do ShelvedCLCount+=1 if [[ "${P4REPLICA}" == "FALSE" || "${SHAREDDATA}" == "TRUE" ]]; then VerifyCmd="$P4 -s verify -qS @=$ShelvedCL" else VerifyCmd="$P4 -s verify -qS -t @=$ShelvedCL" fi cmd "$VerifyCmd" || ShelvedCLErrorCount+=1 done < "$TmpFile" else msg "Error: Could not get or write list of shelved changes." VerifyFailed=1 fi if [[ "$ShelvedCLCount" -ne 0 ]]; then if [[ "$ShelvedCLErrorCount" -eq 0 ]]; then msg "\\nAll $ShelvedCLCount shelved changes verified OK." else msg "\\nOf $ShelvedCLCount shelved changes verified, $ShelvedCLErrorCount had errors." VerifyFailed=1 fi else msg "\\nThere were no shelved changelists to verify." fi else msg "Skipping verify of shelved changelists due to '-nS'." fi if [[ "$VerifyFailed" -ne 0 ]]; then StatusMessage="Error: Verify attempt failed. Review the log [$Log]." ExitCode=1 fi if [[ $ExitCode -eq 0 ]]; then # Note: Ignore SC2196 due to 'grep -e' and 'egrep' not having consistent # results on all platfroms. # shellcheck disable=SC2196 if egrep -m1 '(BAD!|MISSING!|p4 help max)' "$Log" > /dev/null 2>&1; then StatusMessage="Error: Verify errors detected. Review the log [$Log]." ExitCode=2 fi fi msg "Completed verifications at $(date), taking $((SECONDS/3600)) hours $((SECONDS%3600/60)) minutes $((SECONDS%60)) seconds.\n" mail_log_file "$HOSTNAME $P4SERVER P4Verify Log ($StatusMessage)" [[ "$ShowLog" -eq 1 && -s "$Log" ]] && cat "$Log" exit $ExitCode
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#1 | 27246 | Jessie Fernandez | Branch for Jessie Fernandez | ||
//guest/perforce_software/sdp/dev/Server/Unix/p4/common/bin/p4verify.sh | |||||
#34 | 27216 | C. Thomas Tyler |
Non-functional change: Fixed a common doc type: paramter -> parameter |
||
#33 | 27107 | C. Thomas Tyler |
Reworked how shelved files are verified. If shelved files are to be verified, shelved changelists are processed rather than verifying by association with depots. This now complies with documented restriction per 'p4 help verify' that only the @= revision specifier is valid when the '-S' flag is used. If '-recent' is specifed, only the most recent N shelved changelists are verified. #review-27108 |
||
#32 | 26847 | Robert Cowham | Put back the include tags for AsciiDoc | ||
#31 | 26815 | C. Thomas Tyler | Patch: Fixed bug in '-recent' flag to p4verify.sh. | ||
#30 | 26755 | Robert Cowham | Include p4verify.sh man page in SDP Guide automatically for usage section. | ||
#29 | 25547 | C. Thomas Tyler |
p4verify.sh v5.2.0: Added targeting flags: -nu - No Unload -nr - No Regular archived files. -ns - No Spec Depot -nS - No Shelved -a - Archive Depot verify. Verification of archive depots with '-A' is now supported, though not enabled by default as archive depots are typically in cold storage. Also made doc tweaks, enhanced description of '-L' flag and correcting '-h' usage. Added warning message if an unknown depot type is encountered. Unknown depot types are ignored, as new depot types typically require new logic to handle. More updates for shellcheck compliance. |
||
#28 | 25452 | C. Thomas Tyler | Bumped Version ID for change @25451. | ||
#27 | 25451 | Robert Cowham | Fix failing test - local cmd function was being overwritten by sourcing backup_functions.sh | ||
#26 | 25238 | C. Thomas Tyler |
Replaced references to /tmp with P4TMP (e.g. /p4/N/tmp) to avoid issues with SELinux incompatibility. For p4verify.sh, enhanced: * Minor performance enhancement: Added '-m1' flag to egrep that determines whether to exit code with non-zero, as we only need to detect one occurence. * Changed 'Warning:' to 'Error:' if verify errors are detected. * Removed redundant check that SDP_INSTANCE is set. * Added total time info. * Adjusted to pass 'shellcheck.sh' check. #review-25239 |
||
#25 | 24967 | C. Thomas Tyler | Merged patch fix from Karl in main to dev. | ||
#24 | 24218 | C. Thomas Tyler |
Enhanced performance of "p4 verify.sh -recent" by lowering default changelists to scan per depot, and skipping shelves. Also fixed indentation/style issues. |
||
#23 | 23750 | C. Thomas Tyler |
In p4verify.sh, fixed handling of unload and spec depots. Unload depots were not being identified correctly, and so special flags needed for unload-type depots were not applied. For spec-type depots, 'p4 verify -qS' was run, which isn't necessary or helpful since it is not possible to shelve files in the spec depot. The fix included replacing parsing logic with optimized p4 commands that don't require parsing. |
||
#22 | 22074 | Russell C. Jackson (Rusty) |
Corrected the name of the variable. Already reviewed with Tom. |
||
#21 | 22066 | Russell C. Jackson (Rusty) | Added rotate for p4verify.log instead of just deleting the prior one. | ||
#20 | 21233 | Russell C. Jackson (Rusty) | Review 21010 from Adrian commit. | ||
#19 | 21007 | adrian_waters | Fix specification of depot path in get_verify_rev_range when -recent used | ||
#18 | 20995 | C. Thomas Tyler |
Style tweak; using double-square brakets rather than single-square brackets. |
||
#17 | 20994 | adrian_waters |
Refactor around changes to support -recent arg - had broken code even where -recent not used because of unbounded variable ($d); use of the -recent option also fails as 'verify -S' not valid for shelved files (only @= is supported) ; stripping out archive,unload+remote depots also not working + get_verify_rev_range used depot name incorrectly in changes (eg, changed -m 1 depot/... rather than //depot/...) Raised job000634 for changes. Further aim is to modify script for depots with no shelved files does not result in an 'error' line being written to p4verify.log - it confuses clients - will do that as a separate change. |
||
#16 | 20909 | Russell C. Jackson (Rusty) | Fixed missing LOGFILE variable issue. | ||
#15 | 20879 | Robert Cowham | Fix typo in variable name. | ||
#14 | 20868 | C. Thomas Tyler |
Add '-recent' flag to p4verify.sh to verify only recent changes. Usage info is added with '-h' and '-man' flags. This change involved changing the command line parsing to accept the <instance> positional parameter and '-recent' flag, as well as standard '-v' and '-D' flags. This change also should reduce memory requirement in cases where there are a large number of verify errors. This was done by combining greps and tossing 'grep' output to /dev/null, using only the grep exit code to determine if BAD/MISSING (etc.) appear in the log. Added a Version id. (Need to avoid +k due to the way SDP files move around from server to server). This must be updated manually. |
||
#13 | 20086 | Russell C. Jackson (Rusty) | Added -t to verify of shelves on a replica, and added verify of shelves on the master. | ||
#12 | 20083 | Russell C. Jackson (Rusty) | Added missing echo of command into log file. | ||
#11 | 19314 | Russell C. Jackson (Rusty) |
Change p4verify.sh to use -S to verify shelves on a replica instead of printing the files on the shelf. Removed the HOST_IP settings from mkdirs and instance_vars since it causes problems in a shared depotdata environment, and it was a temporary fix to work around a bug with auth.id that is being fixed. |
||
#10 | 19102 | Russell C. Jackson (Rusty) |
Added check for SHAREDDATA to avoid using -t on a shared data volume replica. Allows running verify on the replica instead of the master. |
||
#9 | 16029 | C. Thomas Tyler |
Routine merge to dev from main using: p4 merge -b perforce_software-sdp-dev |
||
#8 | 15778 | C. Thomas Tyler | Routine Merge Down to dev from main. | ||
#7 | 13906 | C. Thomas Tyler |
Normalized P4INSTANCE to SDP_INSTANCE to get Unix/Windows implementations in sync. Reasons: 1. Things that interact with SDP in both Unix and Windows environments shoudn't have to account for this obscure SDP difference between Unix and Windows. (I came across this doing CBD work). 2. The Windows and Unix scripts have different variable names for defining the same concept, the SDP instance. Unix uses P4INSTANCE, while Windows uses SDP_INSTANCE. 3. This instance tag, a data set identifier, is an SDP concept. I prefer the SDP_INSTANCE name over P4INSTANCE, so I prpose to normalize to SDP_INSTANCE. 4. The P4INSTANCE name makes it look like a setting that might be recognized by the p4d itself, which it is not. (There are other such things such as P4SERVER that could perhaps be renamed as a separate task; but I'm not sure we want to totally disallow the P4 prefix for variable names. It looks too right to be wrong in same cases, like P4BIN and P4DBIN. That's a discussion for another day, outside the scope of this task). Meanwhile: * Fixed a bug in the Windows 2013.3 upgrade script that was referencing undefined P4INSTANCE, as the Windows environment defined only SDP_INSTANCE. * Had P4INSTANCE been removed completely, this change would likely cause trouble for users doing updates for existing SDP installations. So, though it involves slight technical debt, I opted to keep a redundant definition of P4INSTANCE in p4_vars.template, with comments indicating SDP_INSTANCE should be used in favor of P4INSTANCE, with a warning that P4INSTANCE may go away in a future release. This should avoid unnecessary upgrade pain. * In mkdirs.sh, the varialbe name was INSTANCE rather than SDP_INSTANCE. I changed that as well. That required manual change rather than sub/replace to avoid corrupting other similar varialbe names (e.g. MASTERINSTANCE). This is a trivial change technically (a substitute/replace, plus tweaks in p4_vars.template), but impacts many files. |
||
#6 | 13586 | C. Thomas Tyler |
Routine merge down from main -> dev. Trivial merges, all resolved with 'p4 resolve -as.' |
||
#5 | 12169 | Russell C. Jackson (Rusty) |
Updated copyright date to 2015 Updated shell scripts to require an instance parameter to eliminate the need for calling p4master_run. Python and Perl still need it since you have to set the environment for them to run in. Incorporated comments from reviewers. Left the . instead of source as that seems more common in the field and has the same functionality. |
||
#4 | 12028 | C. Thomas Tyler | Refreshed SDP dev branch, merging down from main. | ||
#3 | 11485 | Russell C. Jackson (Rusty) |
Brought over changes from RCJ sdp to properly handle Edge servers and to properly replicate shelves when replicating from Windows to Linux |
||
#2 | 11476 | Russell C. Jackson (Rusty) | Fixed echo command to match the actual command run. | ||
#1 | 10638 | C. Thomas Tyler | Populate perforce_software-sdp-dev. | ||
//guest/perforce_software/sdp/main/Server/Unix/p4/common/bin/p4verify.sh | |||||
#1 | 10148 | C. Thomas Tyler | Promoted the Perforce Server Deployment Package to The Workshop. |