Test::Unix::Group - Test::Builder based tests for Unix groups

    use Test::Unix::Group tests => 4;

    group_ok({ name => 'wheel' }, "'wheel' must exist");
    group_ok({ name => 'wheel' }); # Auto-generate test name
    group_ok({ name => 'wheel',
               gid  => 0, }, "'wheel' must have gid 0");

    group_ok({ name => 'wheel', members => [qw(root nik)], }
             "'wheel' has the correct members");

    Checking group '$group' ($key, $key, $key, ...)

    group_ok({ name => 'wheel' }, "Group 'wheel' exists");

    group_ok({ name => 'wheel', gid => 0 });

    group_ok({ name => 'wheel', members => [ qw(root nik) ] });

 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.

package Test::Unix::Group;

# Copyright (c) 2005 Nik Clayton
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#     documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.

use warnings;
use strict;

use Test::Builder;

require Exporter;
our @ISA = qw(Exporter);
our @EXPORT = qw(group_ok);

my $Test = Test::Builder->new;

use User::pwent;
use User::grent;

my @GROUP_FIELDS = qw(name gid passwd members);
my %GROUP_FIELDS = map { $_ => 1 } @GROUP_FIELDS;

sub import {
  my($self) = shift;
  my $pack = caller;

  $Test->exported_to($pack);
  $Test->plan(@_);

  $self->export_to_level(1, $self, qw(group_ok));
}

our $VERSION = '0.01';

sub group_ok {
  my($spec, $test_name) = @_;

  if(! defined $spec) {
    my $ok = $Test->ok(0, "group_ok()");
    $Test->diag("    group_ok() called with no arguments");
    return $ok;
  }

  if(ref($spec) ne 'HASH') {
    my $ok = $Test->ok(0, 'group_ok()');
    $Test->diag("    First argument to group_ok() must be a hash ref");
    return $ok;
  }

  if(! exists $spec->{name} or 
     ! defined $spec->{name} or 
       $spec->{name} =~ /^\s*$/) {
    my $t = $test_name;
    $t = "group_ok(...)" unless defined $t;
    my $ok = $Test->ok(0, $t);
    $Test->diag("    group_ok() called with no group name");
    return $ok;
  }

  if(! defined $test_name) {
    $test_name = "Checking group '$spec->{name}'";
    $test_name .= ' (' . join(', ', sort keys %$spec) . ')';
  }

  my($g, @diag);

  $g = getgrnam($spec->{name});

  if(! defined $g) {
    my $ok = $Test->ok(0, $test_name);
    $Test->diag("    Group '$spec->{name}' does not exist");
    return $ok;
  }

  foreach my $field (keys %$spec) {
    if(! exists $GROUP_FIELDS{$field}) {
      push @diag, "    Invalid field '$field' given";
      next;
    }

    if(! defined $spec->{$field} or $spec->{$field} =~ /^\s*$/) {
      push @diag, "    Empty field '$field' given";
      next;
    }

    # All members in $spec->{members} must exist in the group, either
    # in the members returned by getgrnam(), or, if any are left over,
    # by checking each account's group membership.
    if($field eq 'members') {
      my %exp_members = map { $_ => 1 } @{$spec->{members}};

      delete $exp_members{$_} foreach @{$g->members};

      # Any members left?  If so, check their group ownership
      foreach my $name (sort keys %exp_members) {
	my $u = getpwnam($name);
	if(! defined $u) {
	  push @diag, "    You looked for user '$name' in group '$spec->{name}'\n";
	  push @diag, "    That account does not exist on this system";
	  next;
	}

	if($g->gid != $u->gid) {
	  push @diag, "    Field: members\n";
	  push @diag, "    expected: user '$name' with gid " . $g->gid . "\n";
	  push @diag, "         got: user '$name' with gid " . $u->gid . "\n";
	}
      }

      next;
    }

    if($spec->{$field} ne $g->$field) {
      push @diag, "    Field: $field\n";
      push @diag, "    expected: $spec->{$field}\n";
      push @diag, "         got: " . $g->$field . "\n";
      next;
    }
  }

  if(@diag) {
    my $ok = $Test->ok(0, $test_name);
    $Test->diag(@diag);
    return $ok;
  }

  return $Test->ok(1, $test_name);
}

1; # End of Test::Unix::Group