2140N/A<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2887N/A<!DOCTYPE stax SYSTEM "/shared/stax.dtd">
2140N/A<!--
2140N/A ! CDDL HEADER START
2140N/A !
2140N/A ! The contents of this file are subject to the terms of the
2140N/A ! Common Development and Distribution License, Version 1.0 only
2140N/A ! (the "License"). You may not use this file except in compliance
2140N/A ! with the License.
2140N/A !
6982N/A ! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
6982N/A ! or http://forgerock.org/license/CDDLv1.0.html.
2140N/A ! See the License for the specific language governing permissions
2140N/A ! and limitations under the License.
2140N/A !
2140N/A ! When distributing Covered Code, include this CDDL HEADER in each
6982N/A ! file and include the License file at legal-notices/CDDLv1_0.txt.
6982N/A ! If applicable, add the following below this CDDL HEADER, with the
6982N/A ! fields enclosed by brackets "[]" replaced with your own identifying
6982N/A ! information:
2140N/A ! Portions Copyright [yyyy] [name of copyright owner]
2140N/A !
2140N/A ! CDDL HEADER END
2140N/A !
4618N/A ! Copyright 2007-2009 Sun Microsystems, Inc.
2140N/A ! -->
2140N/A<stax>
2235N/A <defaultcall function="logging_retention"/>
2235N/A <function name="logging_retention" scope="local">
2235N/A <block name="STAXCurrentFunction">
4618N/A <try>
4618N/A <sequence>
4618N/A <script>
4618N/A CurrentTestPath['suite']=STAXCurrentFunction
4618N/A </script>
4618N/A <call function="'testSuite_Preamble'" />
4618N/A
4618N/A <call function="'common_setup'">
4618N/A {
4618N/A 'quickStart' : True ,
4618N/A 'startServer' : True ,
4618N/A 'stopServer' : False
4618N/A }
4618N/A </call>
4618N/A
4618N/A <!--- Test Suite information
4618N/A #@TestSuiteName Retention Policy Tests
4618N/A #@TestSuitePurpose Verify the Retention Policy
4618N/A #@TestSuiteID Logging
4618N/A #@TestSuiteGroup Logging
4618N/A #@TestGroup Logging
4618N/A #@TestScript logging_retention.xml
4618N/A #@TestHTMLLink http://opends.dev.java.net/
4618N/A -->
4618N/A
3153N/A
4618N/A <!--- Test Case : retention policy -->
4618N/A <!---
4618N/A #@TestMarker Retention Policy Tests
4618N/A #@TestName Count limit retention policy
4618N/A #@TestPurpose Check the count retention policy
4618N/A #@TestPreamble none
4618N/A #@TestStep Create a new count limit retention policy
4618N/A #@TestStep Configure the count Limit retention policy with a Max file to 3
4618N/A #@TestStep Execute ldapsearch request until the log are cleaned
4618N/A #@TestPostamble none
4618N/A #@TestResult the number of logs must not exceed 3
4618N/A -->
4618N/A <testcase name="getTestCaseName('Count limit retention')">
4618N/A <sequence>
4618N/A <call function="'testCase_Preamble'"/>
4618N/A <message>
4618N/A '---- Check the file count -----'
4618N/A </message>
4618N/A <!-- set the max number of files to keep -->
4618N/A <script>
4618N/A numberFiles=5
4618N/A maxFiles=6
4618N/A </script>
4618N/A
4618N/A <call function="'ldapSearchWithScript'">
4618N/A { 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST,
4618N/A 'dsInstancePort' : DIRECTORY_INSTANCE_PORT ,
4618N/A 'dsBaseDN' : DIRECTORY_INSTANCE_SFX,
4618N/A 'dsInstanceDn' : DIRECTORY_INSTANCE_DN,
4618N/A 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD,
4618N/A 'dsFilter' : 'objectclass=*',
4618N/A 'dsScope' : 'base',
4618N/A 'expectedRC' : 0
4618N/A }
4618N/A </call>
4618N/A
4618N/A <message>
4618N/A '-- create a new file count retention policy --'
4618N/A </message>
4618N/A <call function="'dsconfig'">
4618N/A { 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST,
4618N/A 'dsInstanceDn' : DIRECTORY_INSTANCE_DN,
4618N/A 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD,
4618N/A 'subcommand' : 'create-log-retention-policy',
4618N/A 'objectType' : 'policy-name',
4618N/A 'objectName' : 'my file count retention policy',
4618N/A 'optionsString' : '--type file-count --set number-of-files:%s' % (numberFiles),
4618N/A 'expectedRC' : 0
4618N/A }
4618N/A </call>
4618N/A
4618N/A <message>
4618N/A '------ Add this retention policy to the Access log publisher --'
4618N/A </message>
4618N/A <call function="'dsconfig'">
4618N/A { 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST,
4618N/A 'dsInstanceDn' : DIRECTORY_INSTANCE_DN,
4618N/A 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD,
4618N/A 'subcommand' : 'set-log-publisher-prop',
4618N/A 'objectType' : 'publisher-name',
4618N/A 'objectName' : 'File-Based Access Logger',
4618N/A 'optionsString' : '--add retention-policy:"my file count retention policy"',
4618N/A 'expectedRC' : 0
4618N/A }
4618N/A </call>
4618N/A <message>
4618N/A '-- create a new size limit rotation policy --'
4618N/A </message>
4618N/A <call function="'dsconfig'">
4618N/A { 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST,
4618N/A 'dsInstanceDn' : DIRECTORY_INSTANCE_DN,
4618N/A 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD,
4618N/A 'subcommand' : 'create-log-rotation-policy',
4618N/A 'objectType' : 'policy-name',
4618N/A 'objectName' : 'my size Limit Rotation Policy',
4618N/A 'optionsString' : '--type size-limit --set file-size-limit:2kb',
4618N/A 'expectedRC' : 0
4618N/A }
4618N/A </call>
4618N/A <message>
4618N/A '------ Add this rotation policy to the Access log publisher --'
4618N/A </message>
4618N/A <call function="'dsconfig'">
4618N/A { 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST,
4618N/A 'dsInstanceDn' : DIRECTORY_INSTANCE_DN,
4618N/A 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD,
4618N/A 'subcommand' : 'set-log-publisher-prop',
4618N/A 'objectType' : 'publisher-name',
4618N/A 'objectName' : 'File-Based Access Logger',
4618N/A 'optionsString' : '--add rotation-policy:"my size Limit Rotation Policy"',
4618N/A 'expectedRC' : 0
4618N/A }
4618N/A </call>
4618N/A
4618N/A <call function="'dsconfig'">
4618N/A { 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST,
4618N/A 'dsInstanceDn' : DIRECTORY_INSTANCE_DN,
4618N/A 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD,
4618N/A 'subcommand' : 'set-log-publisher-prop',
4618N/A 'objectType' : 'publisher-name',
4618N/A 'objectName' : 'File-Based Access Logger',
4618N/A 'optionsString' : '--add auto-flush:true --set append:true --set asynchronous:false',
4618N/A 'expectedRC' : 0
4618N/A }
4618N/A </call>
4618N/A
4618N/A
4618N/A <!-- Get configuration -->
4618N/A
4618N/A
4618N/A <call function="'dsconfig'">
4618N/A { 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST,
4618N/A 'dsInstanceDn' : DIRECTORY_INSTANCE_DN,
4618N/A 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD,
4618N/A 'subcommand' : 'get-log-publisher-prop',
4618N/A 'objectType' : 'publisher-name',
4618N/A 'objectName' : 'File-Based Access Logger',
4618N/A 'expectedRC' : 0
4618N/A }
4618N/A </call>
4618N/A
4618N/A <call function="'dsconfig'">
4618N/A { 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST,
4618N/A 'dsInstanceDn' : DIRECTORY_INSTANCE_DN,
4618N/A 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD,
4618N/A 'subcommand' : 'get-log-rotation-policy-prop',
4618N/A 'objectType' : 'policy-name',
4618N/A 'objectName' : 'my size Limit Rotation Policy',
4618N/A 'expectedRC' : 0
4618N/A }
4618N/A </call>
4618N/A
4618N/A <call function="'dsconfig'">
4618N/A { 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST,
4618N/A 'dsInstanceDn' : DIRECTORY_INSTANCE_DN,
4618N/A 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD,
4618N/A 'subcommand' : 'get-log-retention-policy-prop',
4618N/A 'objectType' : 'policy-name',
4618N/A 'objectName' : 'my file count retention policy',
4618N/A 'expectedRC' : 0
4618N/A }
4618N/A </call>
4618N/A
4618N/A
4618N/A <!-- Starting loop -->
4618N/A
4618N/A <!-- Execute ldapsearch until we detect a log rotation -->
4618N/A <!-- Check the number of logs files never exceed the number-of-files -->
4618N/A <script>
4618N/A cpt=0
4618N/A error=0
4618N/A </script>
2480N/A
4618N/A <loop from="1" to="10" until="error != 0">
4618N/A <sequence>
4618N/A <message>'###########################'</message>
4618N/A <message>' LOOP %s :' % cpt </message>
4618N/A <message>'###########################'</message>
4618N/A <message>'--- Execute a Search request ---'</message>
4618N/A
4618N/A <call function="'ldapSearchWithScript'">
4618N/A { 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST,
4618N/A 'dsInstancePort' : DIRECTORY_INSTANCE_PORT,
4618N/A 'dsBaseDN' : DIRECTORY_INSTANCE_SFX,
4618N/A 'dsInstanceDn' : DIRECTORY_INSTANCE_DN,
4618N/A 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD,
4618N/A 'dsFilter' : 'objectclass=*',
4618N/A 'dsScope' : 'base',
4618N/A 'expectedRC' : 0
4618N/A }
4618N/A </call>
4618N/A
4618N/A <call function="'Sleep'">
4680N/A { 'sleepForMilliSeconds' : 5000 }
4618N/A </call>
4618N/A
4618N/A <call function="'listFolder'">
4618N/A { 'location' : DIRECTORY_INSTANCE_HOST,
4618N/A 'foldername' : '%s/%s/logs' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME),
4618N/A 'filename' : 'access'
4618N/A }
4618N/A </call>
4618N/A
4618N/A <if expr="int(len(cmdResult)) > maxFiles">
4618N/A <sequence>
4618N/A <script>
4618N/A error=1
4618N/A </script>
4618N/A <message>
4618N/A 'Error, the number of logs files is %s and exceed the retention policy' % int(len(cmdResult))
4618N/A </message>
4618N/A <call function="'testFailed'" />
4618N/A </sequence>
4618N/A </if>
4618N/A
4618N/A <script>
4618N/A cpt=cpt+1
4618N/A </script>
4618N/A </sequence>
4618N/A </loop>
4618N/A
4618N/A <if expr="error == 0" >
4618N/A <sequence>
4618N/A <message>
4618N/A 'SUCCESS: the retention policy has been checked'
4618N/A </message>
4618N/A <call function="'testPassed'"/>
4618N/A </sequence>
4618N/A </if>
4618N/A
4618N/A <!-- cleanup -->
4618N/A <message>
4618N/A '------ remove this rotation policy to the Access log publisher --'
4618N/A </message>
4618N/A <call function="'dsconfig'">
4618N/A { 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST,
4618N/A 'dsInstanceDn' : DIRECTORY_INSTANCE_DN,
4618N/A 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD,
4618N/A 'subcommand' : 'set-log-publisher-prop',
4618N/A 'objectType' : 'publisher-name',
4618N/A 'objectName' : 'File-Based Access Logger',
4618N/A 'optionsString' : '--remove rotation-policy:"my size Limit Rotation Policy"',
4618N/A 'expectedRC' : 0
4618N/A }
4618N/A </call>
4618N/A
4618N/A <message>
4618N/A '------ remove this retention policy to the Access log publisher --'
4618N/A </message>
4618N/A <call function="'dsconfig'">
4618N/A { 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST,
4618N/A 'dsInstanceDn' : DIRECTORY_INSTANCE_DN,
4618N/A 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD,
4618N/A 'subcommand' : 'set-log-publisher-prop',
4618N/A 'objectType' : 'publisher-name',
4618N/A 'objectName' : 'File-Based Access Logger',
4618N/A 'optionsString' : '--remove retention-policy:"my file count retention policy"',
4618N/A 'expectedRC' : 0
4618N/A }
4618N/A </call>
4618N/A
4618N/A
4618N/A <message>
4618N/A '-- delete a new file count retention policy --'
4618N/A </message>
4618N/A <call function="'dsconfig'">
4618N/A { 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST,
4618N/A 'dsInstanceDn' : DIRECTORY_INSTANCE_DN ,
4618N/A 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD ,
4618N/A 'subcommand' : 'delete-log-retention-policy' ,
4618N/A 'objectType' : 'policy-name' ,
4618N/A 'objectName' : 'my file count retention policy',
4618N/A 'expectedRC' : 0
4618N/A }
4618N/A </call>
4618N/A
4618N/A
4618N/A <message>
4618N/A '-- delete a new size limit rotation policy --'
4618N/A </message>
4618N/A <call function="'dsconfig'">
4618N/A { 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST,
4618N/A 'dsInstanceDn' : DIRECTORY_INSTANCE_DN,
4618N/A 'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD,
4618N/A 'subcommand' : 'delete-log-rotation-policy',
4618N/A 'objectType' : 'policy-name',
4618N/A 'objectName' : 'my size Limit Rotation Policy',
4618N/A 'expectedRC' : 0
4618N/A }
4618N/A </call>
4618N/A
4618N/A <call function="'testCase_Postamble'"/>
4618N/A </sequence>
4618N/A </testcase>
4618N/A
4618N/A </sequence>
4618N/A <finally>
4618N/A <sequence>
4618N/A <!-- Test Suite Cleanup -->
4618N/A <message>'Finally: Global Log Retention Cleanup.'</message>
4618N/A <try>
4618N/A <call function="'common_cleanup'" />
4618N/A <catch exception="'STAFException'">
2235N/A <sequence>
4618N/A <message log="1" level="'fatal'">'Cleanup of test suite failed.'</message>
2235N/A </sequence>
4618N/A </catch>
4618N/A <finally>
4618N/A <call function="'testSuite_Postamble'"/>
4618N/A </finally>
4618N/A </try>
2235N/A </sequence>
4618N/A </finally>
4618N/A
4618N/A </try>
2235N/A </block>
2235N/A </function>
2140N/A</stax>