patch 9.1.0681: tests: Analyzing failed screendumps is hard Commit: https://github.com/vim/vim/commit/6bff6a2fa449b9149eb2db4851e0b62a173b8748 Author: Aliaksei Budavei <0x000c70@gmail.com> Date: Mon Aug 19 21:33:26 2024 +0200 patch 9.1.0681: tests: Analyzing failed screendumps is hard Problem: tests: Analyzing failed screendumps is hard Solution: Facilitate the viewing of rendered screendumps under src/ add some documentation on how to use the viewdumps.vim script (Aliaksei Budavei) With the submitted "viewdumps.vim" script, a few manual steps in typical workflows (see below) can be automated. The updated "README.txt" contains additional information. ============================================================ Reviewing LOCAL failed screendump tests can be arranged as follows: 1) Run tests and generate screendumps: ------------------------------------------------------------ cd /path/to/fork/src/testdir make ------------------------------------------------------------ 2) Examine the screendumps from the "failed" directory: ------------------------------------------------------------ ../vim -u NONE -S viewdumps.vim ------------------------------------------------------------ ============================================================ Reviewing UPLOADED failed screendump tests can be arranged as follows (it can be further locally scripted): 1) Fetch an artifact with failed screendumps from "github.com/vim/vim/actions/runs/A_ID/artifacts/B_ID". 2) Extract the archived files: ------------------------------------------------------------ unzip /tmp/failed-tests.zip -d /tmp ------------------------------------------------------------ 3) Set up the "dumps" directory. Create a symlink to "/path/to/fork/dirs/dumps" in the extracted directories so that term_dumpdiff() can be used. (The lookup algorithm resolves "dumps" for every loaded filename. So, with "/tmp/src/testdir/failed/*.dump" files passed as script arguments, the algorithm will make the files in "/tmp/src/testdir/dumps" queried.) ------------------------------------------------------------ cd /path/to/fork ln -s $(pwd)/src/testdir/dumps /tmp/src/testdir/dumps ------------------------------------------------------------ 4) Examine the extracted screendumps: ------------------------------------------------------------ ./src/vim -u NONE -S src/testdir/viewdumps.vim \ /tmp/src/testdir/failed/*.dump ------------------------------------------------------------ 5) Clean up: ------------------------------------------------------------ unlink /tmp/src/testdir/dumps rm -rf /tmp/src ------------------------------------------------------------ ============================================================ Reviewing SUBMITTED FOR PULL REQUEST screendump tests can be arranged as follows (it can be further locally scripted): 1) List the fetched changeset and write the changed "dumps" filenames to "/tmp/filelist": ------------------------------------------------------------ cd /path/to/fork git switch prs/1234 git diff-index --relative=src/testdir/dumps/ \ --name-only prs/1234~1 > /tmp/filelist ------------------------------------------------------------ 2) Reconcile relative filepaths, and copy next-to-be-updated "dumps" files in the "failed" directory (note the missing new screendumps, if any): ------------------------------------------------------------ git switch master cd src/testdir/dumps test -d ../failed || mkdir ../failed cp -t ../failed $(cat /tmp/filelist) ------------------------------------------------------------ 3) Remember about the introduced INVERTED relation between "dumps" and "failed", i.e. the files to be committed are in "dumps" already and their previous versions are in "failed"; therefore, copy the missing new screendumps from "dumps" to "failed" (otherwise these won't be shown): ------------------------------------------------------------ git switch prs/1234 cp -t ../failed foo_10.dump foo_11.dump foo_12.dump ------------------------------------------------------------ 4) Examine the screendumps from the "failed" directory (new screendumps will be shown with no difference between their versions): ------------------------------------------------------------ cd .. ../vim -u NONE -S viewdumps.vim ------------------------------------------------------------ closes: #15515 Signed-off-by: Aliaksei Budavei <0x000c70@gmail.com> Signed-off-by: Christian Brabandt <cb@256bit.org>

/* autoconf cannot fiddle out declarations. Use our homebrewn tools. (jw) */
/*
 * Declarations that may cause conflicts belong here so that osdef.sh
 * can clean out the forest. Everything else belongs in os_unix.h
 *
 * How this works:
 * - This file contains all unix prototypes that Vim might need.
 * - The shell script osdef.sh is executed at compile time to remove all the
 *   prototypes that are in an include file. This results in osdef.h.
 * - osdef.h is included in vim.h.
 *
 * sed cannot always handle so many commands, this is file 1 of 2
 */

extern int	printf(char *, ...);
extern int	fprintf(FILE *, char *, ...);
extern int	sprintf(char *, char *, ...);
extern int	sscanf(char *, char *, ...);
#ifndef fopen	/* could be redefined to fopen64() */
extern FILE	*fopen(const char *, const char *);
#endif
extern int	fclose(FILE *);
extern int	fseek(FILE *, long, int);
#ifdef HAVE_FSEEKO
extern int	fseeko(FILE *, off_t, int);
#endif
extern long	ftell(FILE *);
#ifdef HAVE_FSEEKO
extern off_t	ftello(FILE *);
#endif
extern void	rewind(FILE *);
extern int	fread(char *, int, int, FILE *);
extern int	fwrite(char *, int, int, FILE *);
extern int	fputs(char *, FILE *);
#ifndef ferror	/* let me say it again: "macros should never have prototypes" */
extern int	ferror(FILE *);
#endif
extern int	fflush(FILE *);
#if defined(sun) || defined(_SEQUENT_)
/* used inside of stdio macros getc(), puts(), putchar()... */
extern int	_flsbuf(int, FILE *);
extern int	_filbuf(FILE *);
#endif

#if !defined(HAVE_SELECT)
struct pollfd;			/* for poll() */
extern int	poll(struct pollfd *, long, int);
#endif

#ifdef HAVE_MEMSET
extern void	*memset(void *, int, size_t);
#endif
extern int	memcmp(const void *, const void *, size_t);
#ifdef HAVE_STRPBRK
extern char	*strpbrk(const char *, const char *);
#endif
#ifdef USEBCOPY
extern void	bcopy(char *, char *, int);
#else
# ifdef USEMEMCPY
extern void	memcpy(char *, char *, int);
# else
#  ifdef USEMEMMOVE
extern void	memmove(char *, char *, int);
#  endif
# endif
#endif
#if !defined(__BIONIC__) && !defined(__HAIKU__)  // Android's libc #defines bzero to memset.
// used inside of FD_ZERO macro
extern void	bzero(void *, size_t);
#endif
#ifdef HAVE_SETSID
extern pid_t	setsid(void);
#endif
#ifdef HAVE_SETPGID
extern int	setpgid(pid_t, pid_t);
#endif
#ifdef HAVE_STRTOL
extern int	strtol(char *, char **, int);
#endif
#ifdef HAVE_STRFTIME
extern size_t	strftime(char *, size_t, char *, struct tm *);
#endif
#ifdef HAVE_STRCASECMP
extern int	strcasecmp(char *, char *);
#endif
#ifdef HAVE_STRNCASECMP
extern int	strncasecmp(char *, char *, size_t);
#endif
#ifndef strdup
extern char	*strdup(const char *);
#endif
extern int	atoi(char *);
extern int	atol(char *);

#ifndef USE_SYSTEM
extern int	fork(void);
# ifndef __TANDEM
extern int	execvp(const char *, const char **);
# endif
extern int	wait(int *); /* will this break things ...? */
extern int	waitpid(pid_t, int *, int);
#endif

extern int	toupper(int);
extern int	tolower(int);

extern void (*signal(int, void (*func) SIGPROTOARG)) SIGPROTOARG;
#ifdef HAVE_SIGSET
extern void (*sigset(int, void (*func) SIGPROTOARG)) SIGPROTOARG;
#endif

#if defined(HAVE_SETJMP_H)
# ifdef HAVE_SIGSETJMP
extern int	sigsetjmp(sigjmp_buf, int);
extern void	siglongjmp(sigjmp_buf, int);
# else
extern int	setjmp(jmp_buf);
extern void	longjmp(jmp_buf, int);
# endif
#endif

extern int	kill(int, int);

#ifndef __TANDEM
extern int	access(char *, int);
#endif
extern int	fsync(int);
extern int	fchown(int, int, int);
#if defined(HAVE_GETCWD) && !defined(sun) && !defined(__TANDEM)
extern char	*getcwd(char *, int);
#else
extern char	*getwd(char *);
#endif
#ifndef __alpha	/* suggested by Campbell */
extern int	ioctl(int, int, ...);
#endif
extern int	chmod(const char *, mode_t);