The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
App-GitHooks-Plugin-PgBouncerAuthSyntax-v1.1.0
River stage zero No dependents
++
/ App::GitHooks::Plugin::PgBouncerAuthSyntax

NAME

App::GitHooks::Plugin::PgBouncerAuthSyntax - Verify that the syntax of PgBouncer auth files is correct.

DESCRIPTION

This plugin verifies that staged PgBouncer authentication files have a proper syntax before allowing the commit to be completed.

See http://pgbouncer.projects.pgfoundry.org/doc/config.html, under the "Authentication File Format" section, for more information about the required syntax.

VERSION

Version 1.1.0

CONFIGURATION OPTIONS

This plugin supports the following options in the [PgBouncerAuthSyntax] section of your .githooksrc file.

        [PgBouncerAuthSyntax]
        file_pattern = /^configs\/pgbouncer\/userlist.txt$/
        comments_setting = disallow

file_pattern

A regular expression that will be checked against the path of files that are committed and that indicates a PgBouncer auth file to analyze when it matches.

        file_pattern = /^configs\/pgbouncer\/userlist.txt$/

comments_setting

As of version 1.5.4, PgBouncer does not allow comments. This will however change in the next release, thanks to this patch.

Configure this setting accordingly based on your PgBouncer version:

  • allow_anywhere

    Allow comments anywhere. Use with PgBouncer versions above 1.5.4 (not included).

            comments_setting = allow_anywhere

  • allow_end_only

    Allow comments at the end of the file only. PgBouncer will stop parsing the auth file as soon as it encounters an incorrectly formatted line, so you can technically add comments at the end of the file. This setting will prevent you from accidentally adding anything but comments once the first comment is seen, to catch errors that are otherwise tricky to debug.

            comments_setting = allow_end_only

  • disallow

    Don't allow comments at all. The safest setting for PgBouncer versions up to 1.5.4 (included).

            comments_setting = disallow

METHODS

get_file_pattern()

Return a pattern to filter the files this plugin should analyze.

        my $file_pattern = App::GitHooks::Plugin::PgBouncerAuthSyntax->get_file_pattern(
                app => $app,
        );

get_file_check_description()

Return a description of the check performed on files by the plugin and that will be displayed to the user, if applicable, along with an indication of the success or failure of the plugin.

        my $description = App::GitHooks::Plugin::PgBouncerAuthSyntax->get_file_check_description();

run_pre_commit_file()

Code to execute for each file as part of the pre-commit hook.

  my $success = App::GitHooks::Plugin::PgBouncerAuthSyntax->run_pre_commit_file();

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/guillaumeaubert/App-GitHooks-Plugin-PgBouncerAuthSyntax/issues/new. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

        perldoc App::GitHooks::Plugin::PgBouncerAuthSyntax

You can also look for information at:

AUTHOR

Guillaume Aubert, <aubertg at cpan.org>.

COPYRIGHT & LICENSE

Copyright 2013-2017 Guillaume Aubert.

This code is free software; you can redistribute it and/or modify it under the same terms as Perl 5 itself.

This program 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 LICENSE file for more details.