Changeset 11234

Timestamp:

08/19/08 11:13:38 (5 months ago)

Author:

/C=ES/O=Warp Networks S.L./CN=ejhernandez@…

Message:

Added several methods to allow add/remove include directives in eBox apache main configuration refs #1103

Location:

branches/remote-services/ebox/src/EBox

Files:

• Apache.pm (modified) (2 diffs)
• t/Apache.t (modified) (3 diffs)

branches/remote-services/ebox/src/EBox/Apache.pm

@@ -44 +44 @@
 use constant RESTRICTED_PATH_TYPE_KEY => 'path_type';
 use constant RESTRICTED_RESOURCE_TYPE_KEY => 'type';
+use constant INCLUDE_KEY => 'includes';
 use constant ABS_PATH => 'absolute';
 use constant REL_PATH => 'relative';
@@ -421 +422 @@
 }
 
+# Method: addInclude
+#
+#      Add an "include" directive to the apache configuration
+#
+# Parameters:
+#
+#      includeFilePath - String the configuration file path to include
+#      in apache configuration
+#
+# Exceptions:
+#
+#      <EBox::Exceptions::MissingArgument> - thrown if any compulsory
+#      argument is missing
+#
+#      <EBox::Exceptions::Internal> - thrown if the given file does
+#      not exists
+#
+sub addInclude
+{
+    my ($self, $includeFilePath) = @_;
+
+    unless(defined($includeFilePath)) {
+        throw EBox::Exceptions::MissingArgument('includeFilePath');
+    }
+    unless(-f $includeFilePath and -r $includeFilePath) {
+        throw EBox::Exceptions::Internal(
+            "File $includeFilePath cannot be read or it is not a file"
+           );
+    }
+    my @includes = @{$self->_includes()};
+    unless ( grep { $_ eq $includeFilePath } @includes) {
+        push(@includes, $includeFilePath);
+        $self->set_list(INCLUDE_KEY, 'string', \@includes);
+    }
+
+}
+
+# Method: removeInclude
+#
+#      Remove an "include" directive to the apache configuration
+#
+# Parameters:
+#
+#      includeFilePath - String the configuration file path to remove
+#      from apache configuration
+#
+# Exceptions:
+#
+#      <EBox::Exceptions::MissingArgument> - thrown if any compulsory
+#      argument is missing
+#
+#      <EBox::Exceptions::Internal> - thrown if the given file has not
+#      been included previously
+#
+sub removeInclude
+{
+    my ($self, $includeFilePath) = @_;
+
+    unless(defined($includeFilePath)) {
+        throw EBox::Exceptions::MissingArgument('includeFilePath');
+    }
+    my @includes = @{$self->_includes()};
+    my @newIncludes = grep { $_ ne $includeFilePath } @includes;
+    if ( @newIncludes eq @includes ) {
+        throw EBox::Exceptions::Internal("$includeFilePath has not been included previously");
+    }
+    $self->set_list(INCLUDE_KEY, 'string', \@newIncludes);
+
+}
+
+# Return those include files that has been added
+sub _includes
+{
+    my ($self) = @_;
+    return $self->get_list(INCLUDE_KEY);
+}
+
 1;

branches/remote-services/ebox/src/EBox/t/Apache.t

@@ -16 +16 @@
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
-# A module to test restricted resources methods on Apache module
+# A module to test restricted resources and includes methods on Apache module
 
 use warnings;
 use strict;
 
-use Test::More tests => 14;
+use Test::More tests => 24;
 use Test::Exception;
 use Test::Deep;
@@ -28 +28 @@
 
 BEGIN {
-    diag('Starting test for restricted resources method on Apache module');
+    diag('Starting test for some methods on Apache module');
     use_ok('EBox::Apache')
       or die;
@@ -102 +102 @@
 } 'EBox::Exceptions::DataNotFound', 'Given resource name not found';
 
+# Include related tests
+my @includes = ( '/bin/true', '/bin/false' );
+my @deviantIncludes = ( '/bin/dafdfa' );
+
+throws_ok {
+    $apacheMod->addInclude();
+} 'EBox::Exceptions::MissingArgument', 'No file to include';
+
+throws_ok {
+    $apacheMod->addInclude($deviantIncludes[0]);
+} 'EBox::Exceptions::Internal', 'File to include does not exits';
+
+lives_ok {
+    $apacheMod->addInclude($_) foreach (@includes);
+} 'Adding some includes';
+
+cmp_deeply($apacheMod->_includes(), \@includes,
+       'The two includes added');
+
+lives_ok {
+    $apacheMod->addInclude($_) foreach (@includes);
+} 'Trying to add the same again';
+
+cmp_deeply($apacheMod->_includes(), \@includes,
+           'Only the two includes are there');
+
+throws_ok {
+    $apacheMod->removeInclude();
+} 'EBox::Exceptions::MissingArgument', 'No file to exclude';
+
+throws_ok {
+    $apacheMod->removeInclude($deviantIncludes[0]);
+} 'EBox::Exceptions::Internal', 'No file to remove';
+
+lives_ok {
+    $apacheMod->removeInclude($_) foreach (@includes);
+} 'Removing all the include files';
+
+cmp_ok(@{$apacheMod->_includes()}, '==', 0,
+       'Nothing has been left');
+
 1;