File Coverage

lib/Clearcase/Vobs.pm

Criterion	Covered	Total	%
statement	24	32	75.0
branch	4	8	50.0
condition			n/a
subroutine	6	8	75.0
pod	4	4	100.0
total	38	52	73.0

=pod

=head1 NAME Vobs.pm

Object oriented interface to Clearcase VOBs

=head1 VERSION

=over

=item Author

Andrew DeFaria

=item Revision

$Revision: 1.17 $

=item Created

Thu Dec 29 12:07:59 PST 2005

=item Modified

$Date: 2011/11/16 19:46:13 $

=back

=head1 SYNOPSIS

Provides access to information about all Clearcase VOBs.

 # Create VOBs object
 my $vobs = new Clearcase::Vobs;

 print "There are " . $vobs->vobs . " vobs to process" . "\n";

 # Iterrate through the list of vobs
 foreach ($vobs->vobs) {
   my $vob = new Clearcase::Vob $_;
   ...
 } # foreach

 # VOBs manipulation
 print "Umounting all vobs" . "\n";

 $vobs->umount;

 print "Mounting all vobs" . "\n";

 $vobs->mount;

=head1 DESCRIPTION

This module implements a Clearcase vobs object to  deal with the lists
of vobs in the current region.

=head1 ROUTINES

The following routines are exported:

=cut

package Clearcase::Vobs;

use strict;
use warnings;

use lib '..';

use Clearcase;

sub new (;$) {
  my ($class, $host, $region) = @_;

=pod

=head2 new (host)

Construct a new Clearcase Vobs object.

Parameters:

=for html

=over

=item host

If host is specified then limit the vob list to only those vobs on that host. If
host is not specified then all vobs are considered

=back

=for html

Returns:

=for html

=over

=item Clearcase VOBs object

=back

=for html

=cut

  my $cmd = 'lsvob -short';
  $cmd .= " -host $host"     if $host;
  $cmd .= " -region $region" if $region;

  my ($status, @output) = $Clearcase::CC->execute ($cmd);

  return if $status;

  return bless {vobs => \@output}, $class;    # bless
}    # new

sub vobs () {
  my ($self) = @_;

=pod

=head3 vobs

Return a list of VOB tags in an array context or the number of vobs in
a scalar context.

Parameters:

=for html

=over

=over

=item none

=back

=back

=for html

Returns:

=for html

=over

=over

=item List of VOBs or number of VOBs

Array of VOB tags in an array context or the number of vobs in a scalar context.

=back

=back

=for html

=cut

  if (wantarray) {
    my @returnVobs = sort @{$self->{vobs}};

    return @returnVobs;
  } else {
    return scalar @{$self->{vobs}};
  }    #if
}    # vobs

sub mount () {
  my ($self) = @_;

=pod

=head3 mount

Mount all VOBs

Parameters:

=for html

=over

=over

=item none

=back

=back

=for html

Returns:

=for html

=over

=over

=item $status

Status from cleartool

=item @output

Ouput from cleartool

=back

=back

=for html

=cut

  my ($status, @output) = $Clearcase::CC->execute ("mount -all");

  return $status;
}    # mount

sub umount () {
  my ($self) = @_;

=pod

=head3 umount

Unmounts all VOBs

Parameters:

=for html

=over

=over

=item none

=back

=back

=for html

Returns:

=for html

=over

=over

=item $status

Status from cleartool

=item @output

Ouput from cleartool

=back

=back

=for html

=cut

  my ($status, @output) = $Clearcase::CC->execute ("umount -all");

  return $status;
}    # umount

1;

=pod

=head2 DEPENDENCIES

=head2 Modules

=over

=item L

=item L

=item L

=back

=head2 BUGS AND LIMITATIONS

There are no known bugs in this module

Please report problems to Andrew DeFaria .

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2020 by [e-mail]

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.38.0 or,
at your option, any later version of Perl 5 you may have available.

=cut