content: /*
   * This library is part of OpenCms -
   * the Open Source Content Management System
   *
   * Copyright (c) Alkacon Software GmbH & Co. KG (https://www.alkacon.com)
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU Lesser General Public
   * License as published by the Free Software Foundation; either
   * version 2.1 of the License, or (at your option) any later version.
   *
   * This library 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 GNU
   * Lesser General Public License for more details.
   *
   * For further information about Alkacon Software GmbH & Co. KG, please see the
   * company website: https://www.alkacon.com
   *
   * For further information about OpenCms, please see the
   * project website: https://www.opencms.org
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   */
  
  package org.opencms.file;
  
  import org.opencms.test.OpenCmsTestCase;
  import org.opencms.test.OpenCmsTestProperties;
  import org.opencms.test.OpenCmsTestResourceFilter;
  
  import java.util.Iterator;
  import java.util.List;
  
  import junit.extensions.TestSetup;
  import junit.framework.Test;
  import junit.framework.TestSuite;
  
  /**
   * Unit test for the "touch" method of the CmsObject.<p>
   *
   */
  public class TestTouch extends OpenCmsTestCase {
  
      /**
       * Default JUnit constructor.<p>
       *
       * @param arg0 JUnit parameters
       */
      public TestTouch(String arg0) {
  
          super(arg0);
      }
  
      /**
       * Test suite for this test class.<p>
       *
       * @return the test suite
       */
      public static Test suite() {
  
          OpenCmsTestProperties.initialize(org.opencms.test.AllTests.TEST_PROPERTIES_PATH);
  
          TestSuite suite = new TestSuite();
          suite.setName(TestTouch.class.getName());
  
          suite.addTest(new TestTouch("testTouchFile"));
          suite.addTest(new TestTouch("testTouchFolder"));
          suite.addTest(new TestTouch("testTouchFolderRecursive"));
  
          TestSetup wrapper = new TestSetup(suite) {
  
              @Override
              protected void setUp() {
  
                  setupOpenCms("simpletest", "/");
              }
  
              @Override
              protected void tearDown() {
  
                  removeOpenCms();
              }
          };
  
          return wrapper;
      }
  
      /**
       * Test the touch method to touch a single resource.<p>
       * @param tc the OpenCmsTestCase
       * @param cms the CmsObject
       * @param resource1 the resource to touch
       * @throws Throwable if something goes wrong
       */
      public static void touchResource(OpenCmsTestCase tc, CmsObject cms, String resource1) throws Throwable {
  
          tc.storeResources(cms, resource1);
  
          long timestamp = System.currentTimeMillis();
          cms.lockResource(resource1);
          cms.setDateLastModified(resource1, timestamp, false);
          cms.unlockResource(resource1);
  
          // now evaluate the result
          tc.assertFilter(cms, resource1, OpenCmsTestResourceFilter.FILTER_TOUCH);
          // project must be current project
          tc.assertProject(cms, resource1, cms.getRequestContext().getCurrentProject());
          // state must be "changed"
          tc.assertState(cms, resource1, tc.getPreCalculatedState(resource1));
          // date last modified must be the date set in the tough operation
          tc.assertDateLastModified(cms, resource1, timestamp);
          // the user last modified must be the current user
          tc.assertUserLastModified(cms, resource1, cms.getRequestContext().getCurrentUser());
      }
  
      /**
       * Test the touch method to touch a single folder.<p>
       * @param tc the OpenCmsTestCase
       * @param cms the CmsObject
       * @param resource1 the resource to touch
       * @throws Throwable if something goes wrong
       */
      public static void touchResources(OpenCmsTestCase tc, CmsObject cms, String resource1) throws Throwable {
  
          tc.storeResources(cms, resource1);
  
          long timestamp = System.currentTimeMillis();
          cms.lockResource(resource1);
          cms.setDateLastModified(resource1, timestamp, false);
          cms.unlockResource(resource1);
  
          // now evaluate the result
          tc.assertFilter(cms, resource1, OpenCmsTestResourceFilter.FILTER_TOUCH);
          // project must be current project
          tc.assertProject(cms, resource1, cms.getRequestContext().getCurrentProject());
          // state must be "changed"
          tc.assertState(cms, resource1, tc.getPreCalculatedState(resource1));
          // date last modified must be the date set in the tough operation
          tc.assertDateLastModified(cms, resource1, timestamp);
          // the user last modified must be the current user
          tc.assertUserLastModified(cms, resource1, cms.getRequestContext().getCurrentUser());
  
          // evaluate all subresources
          List subresources = cms.readResources(resource1, CmsResourceFilter.ALL);
  
          // iterate through the subresources
          Iterator i = subresources.iterator();
          while (i.hasNext()) {
              CmsResource res = (CmsResource)i.next();
              String resName = cms.getSitePath(res);
              // now evaluate the result
              tc.assertFilter(cms, resName, OpenCmsTestResourceFilter.FILTER_EQUAL);
          }
      }
  
      /**
       * Test the touch method to touch a complete subtree.<p>
       * @param tc the OpenCmsTestCase
       * @param cms the CmsObject
       * @param resource1 the resource to touch
       * @throws Throwable if something goes wrong
       */
      public static void touchResourcesRecursive(OpenCmsTestCase tc, CmsObject cms, String resource1) throws Throwable {
  
          tc.storeResources(cms, resource1);
  
          long timestamp = System.currentTimeMillis();
          cms.lockResource(resource1);
          cms.setDateLastModified(resource1, timestamp, true);
          cms.unlockResource(resource1);
  
          // now evaluate the result
          tc.assertFilter(cms, resource1, OpenCmsTestResourceFilter.FILTER_TOUCH);
          // project must be current project
          tc.assertProject(cms, resource1, cms.getRequestContext().getCurrentProject());
          // state must be "changed"
          tc.assertState(cms, resource1, tc.getPreCalculatedState(resource1));
          // date last modified must be the date set in the tough operation
          tc.assertDateLastModified(cms, resource1, timestamp);
          // the user last modified must be the current user
          tc.assertUserLastModified(cms, resource1, cms.getRequestContext().getCurrentUser());
  
          // evaluate all subresources
          List subresources = cms.readResources(resource1, CmsResourceFilter.ALL);
  
          // iterate through the subresources
          Iterator i = subresources.iterator();
          while (i.hasNext()) {
              CmsResource res = (CmsResource)i.next();
              String resName = cms.getSitePath(res);
              // now evaluate the result
              tc.assertFilter(cms, resName, OpenCmsTestResourceFilter.FILTER_TOUCH);
              // project must be current project
              tc.assertProject(cms, resName, cms.getRequestContext().getCurrentProject());
              // state must be "changed"
              tc.assertState(cms, resName, tc.getPreCalculatedState(resName));
              // date last modified must be the date set in the tough operation
              tc.assertDateLastModified(cms, resName, timestamp);
              // the user last modified must be the current user
              tc.assertUserLastModified(cms, resName, cms.getRequestContext().getCurrentUser());
          }
      }
  
      /**
       * Test the touch method on a file.<p>
       *
       * @throws Throwable if something goes wrong
       */
      public void testTouchFile() throws Throwable {
  
          CmsObject cms = getCmsObject();
          echo("Testing touch on file");
          touchResource(this, cms, "/index.html");
      }
  
      /**
       * Test the touch method on a folder.<p>
       *
       * @throws Throwable if something goes wrong
       */
      public void testTouchFolder() throws Throwable {
  
          CmsObject cms = getCmsObject();
          echo("Testing touch on a folder (without recursion)");
          touchResources(this, cms, "/folder1/");
      }
  
      /**
       * Test the touch method on a folder and recusivly on all resources in the folder.<p>
       *
       * @throws Throwable if something goes wrong
       */
      public void testTouchFolderRecursive() throws Throwable {
  
          CmsObject cms = getCmsObject();
          echo("Testing touch on a folder (_with_ recursion)");
          touchResourcesRecursive(this, cms, "/folder2/");
      }
  }
  