* This program is free software; you can redistribute it and/or modify it under the

* terms of the GNU General Public License, version 2 as published by the Free Software

* Foundation.

*

* You should have received a copy of the GNU General Public License along with this

* program; if not, you can obtain a copy at http://www.gnu.org/licenses/gpl-2.0.html

* or from the Free Software Foundation, Inc.,

* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

*

* This program 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 General Public License for more details.

*

*

* Copyright 2006 - 2013 Pentaho Corporation.  All rights reserved.

*/

* Integration test. Tests {@link org.pentaho.platform.repository2.unified.DefaultUnifiedRepository} and {@link org.pentaho.platform.api.engine.IAuthorizationPolicy} fully configured

* behind Spring Security's method security and Spring's transaction interceptor.

*

* <p>

* Note the RunWith annotation that uses a special runner that knows how to setup a Spring application context. The

* application context config files are listed in the ContextConfiguration annotation. By implementing

* {@link org.springframework.context.ApplicationContextAware}, this unit test can access various beans defined in the application context,

* including the bean under test.

* </p>

*

* @author mlowery

*/

@RunWith( SpringJUnit4ClassRunner.class )

    "classpath:/repository-test-override.spring.xml" } )

  // ~ Static fields/initializers

  // ======================================================================================

  private static final String NAMESPACE_REPOSITORY = "org.pentaho.repository";

  private static final String NAMESPACE_SECURITY = "org.pentaho.security";

  private static final String NAMESPACE_SCHEDULER = "org.pentaho.scheduler";

  private static final String NAMESPACE_PENTAHO = "org.pentaho";

  private static final String NAMESPACE_DOESNOTEXIST = "doesnotexist";

  private static final String RUNTIME_ROLE_ACME_ADMIN = "acme_Admin";

  private static final String RUNTIME_ROLE_ACME_AUTHENTICATED = "acme_Authenticated";

  private final String USERNAME_SUZY = "suzy";

  private final String USERNAME_TIFFANY = "tiffany";

  private final String USERNAME_PAT = "pat";

  private final String USERNAME_ADMIN = "admin";

  private final String USERNAME_GEORGE = "george";

  private final String TENANT_ID_ACME = "acme";

  private final String TENANT_ID_DUFF = "duff";

  // ~ Instance fields

  // =================================================================================================

  private ITenantManager tenantManager;

  private IUnifiedRepository repo;

  private String repositoryAdminUsername;

  private IBackingRepositoryLifecycleManager repositoryLifecyleManager;

  private IBackingRepositoryLifecycleManager defaultBackingRepositoryLifecycleManager;

  /**

   * Used for state verification and test cleanup.

   */

  private JcrTemplate testJcrTemplate;

  private JcrTemplate jcrTemplate;

  private IRoleAuthorizationPolicyRoleBindingDao roleBindingDao;

  private IRoleAuthorizationPolicyRoleBindingDao roleBindingDaoTarget;

  private IRepositoryFileDao repositoryFileDao;

  private IAuthorizationPolicy authorizationPolicy;

  private MicroPlatform mp;

  private ITenantedPrincipleNameResolver userNameUtils = new DefaultTenantedPrincipleNameResolver();

  private ITenantedPrincipleNameResolver roleNameUtils = new DefaultTenantedPrincipleNameResolver(

      DefaultTenantedPrincipleNameResolver.ALTERNATE_DELIMETER );

  private String superAdminRoleName;

  private String tenantAdminRoleName;

  private String tenantAuthenticatedRoleName;

  private String sysAdminUserName;

  private ITenant systemTenant;

  private IPathConversionHelper pathConversionHelper;

  IUserRoleDao userRoleDao;

  IUserRoleDao testUserRoleDao;

  IRepositoryFileAclDao repositoryFileAclDao;

  private static TransactionTemplate jcrTransactionTemplate;

  private TransactionTemplate txnTemplate;

  // ~ Constructors

  // ====================================================================================================

  public DefaultUnifiedRepositorySpecialCharacterTest() throws Exception {

    super();

  }

  // ~ Methods

  // =========================================================================================================

  @BeforeClass

  public static void setUpClass() throws Exception {

    // folder cannot be deleted at teardown shutdown hooks have not yet necessarily completed

    // parent folder must match jcrRepository.homeDir bean property in repository-test-override.spring.xml

    FileUtils.deleteDirectory( new File( "/tmp/jackrabbit-test-TRUNK" ) );

    PentahoSessionHolder.setStrategyName( PentahoSessionHolder.MODE_GLOBAL );

  }

  @AfterClass

  public static void tearDownClass() throws Exception {

    PentahoSessionHolder.setStrategyName( PentahoSessionHolder.MODE_INHERITABLETHREADLOCAL );

  }

  @Before

  public void setUp() throws Exception {

    loginAsRepositoryAdmin();

    SimpleJcrTestUtils.deleteItem( testJcrTemplate, ServerRepositoryPaths.getPentahoRootFolderPath() );

    mp = new MicroPlatform();

    // used by DefaultPentahoJackrabbitAccessControlHelper

    mp.defineInstance( "tenantedUserNameUtils", userNameUtils );

    mp.defineInstance( "tenantedRoleNameUtils", roleNameUtils );

    mp.defineInstance("ILockHelper", new DefaultLockHelper(userNameUtils));

    mp.defineInstance( IAuthorizationPolicy.class, authorizationPolicy );

    mp.defineInstance( ITenantManager.class, tenantManager );

    mp.defineInstance( "roleAuthorizationPolicyRoleBindingDaoTarget", roleBindingDaoTarget );

    mp.defineInstance( "repositoryAdminUsername", repositoryAdminUsername );

    mp.defineInstance("RepositoryFileProxyFactory", new RepositoryFileProxyFactory(this.jcrTemplate, this.repositoryFileDao));

    mp.defineInstance("ITenantedPrincipleNameResolver", new DefaultTenantedPrincipleNameResolver());

    // Start the micro-platform

    mp.start();

    loginAsRepositoryAdmin();

    setAclManagement();

    systemTenant =

        tenantManager.createTenant( null, ServerRepositoryPaths.getPentahoRootFolderName(), tenantAdminRoleName,

            tenantAuthenticatedRoleName, "Anonymous" );

    userRoleDao.createUser( systemTenant, sysAdminUserName, "password", "", new String[] { tenantAdminRoleName } );

    logout();

  }

  private void setAclManagement() {

    testJcrTemplate.execute( new JcrCallback() {

      @Override

      public Object doInJcr( Session session ) throws IOException, RepositoryException {

        PentahoJcrConstants pentahoJcrConstants = new PentahoJcrConstants( session );

        Workspace workspace = session.getWorkspace();

        PrivilegeManager privilegeManager = ( (JackrabbitWorkspace) workspace ).getPrivilegeManager();

        try {

          privilegeManager.getPrivilege( pentahoJcrConstants.getPHO_ACLMANAGEMENT_PRIVILEGE() );

        } catch ( AccessControlException ace ) {

          privilegeManager.registerPrivilege( pentahoJcrConstants.getPHO_ACLMANAGEMENT_PRIVILEGE(), false,

              new String[0] );

        }

        session.save();

        return null;

      }

    } );

  }

  private void cleanupUserAndRoles( final ITenant tenant ) {

    loginAsRepositoryAdmin();

    for ( IPentahoRole role : testUserRoleDao.getRoles( tenant ) ) {

      testUserRoleDao.deleteRole( role );

    }

    for ( IPentahoUser user : testUserRoleDao.getUsers( tenant ) ) {

      testUserRoleDao.deleteUser( user );

    }

  }

  @After

  public void tearDown() throws Exception {

    // null out fields to get back memory

    authorizationPolicy = null;

    login( sysAdminUserName, systemTenant, new String[] { tenantAdminRoleName, tenantAuthenticatedRoleName } );

    ITenant tenant =

        tenantManager.getTenant( "/" + ServerRepositoryPaths.getPentahoRootFolderName() + "/" + TENANT_ID_ACME );

    if ( tenant != null ) {

      cleanupUserAndRoles( tenant );

    }

    login( sysAdminUserName, systemTenant, new String[] { tenantAdminRoleName, tenantAuthenticatedRoleName } );

    tenant = tenantManager.getTenant( "/" + ServerRepositoryPaths.getPentahoRootFolderName() + "/" + TENANT_ID_DUFF );

    if ( tenant != null ) {

      cleanupUserAndRoles( tenant );

    }

    cleanupUserAndRoles( systemTenant );

    SimpleJcrTestUtils.deleteItem( testJcrTemplate, ServerRepositoryPaths.getPentahoRootFolderPath() );

    logout();

    repositoryAdminUsername = null;

    tenantAdminRoleName = null;

    tenantAuthenticatedRoleName = null;

    roleBindingDao = null;

    authorizationPolicy = null;

    testJcrTemplate = null;

    tenantManager = null;

    repo = null;

    repositoryLifecyleManager = null;

    defaultBackingRepositoryLifecycleManager = null;

    roleBindingDaoTarget = null;

    repositoryFileDao = null;

    authorizationPolicy = null;

    mp = null;

    superAdminRoleName = null;

    tenantAdminRoleName = null;

    tenantAuthenticatedRoleName = null;

    sysAdminUserName = null;

    systemTenant = null;

    pathConversionHelper = null;

    userRoleDao = null;

    testUserRoleDao = null;

    repositoryFileAclDao = null;

    jcrTransactionTemplate = null;

    txnTemplate = null;

  }

  @Test

  public void testOnStartup() throws Exception {

    loginAsSysTenantAdmin();

    // make sure pentaho root folder exists

    final String rootFolderPath = ServerRepositoryPaths.getPentahoRootFolderPath();

    assertNotNull( SimpleJcrTestUtils.getItem( testJcrTemplate, rootFolderPath ) );

  }

  @Test

  public void testGetFileWithLoadedMaps() throws Exception {

    login( sysAdminUserName, systemTenant, new String[] { tenantAdminRoleName, tenantAuthenticatedRoleName } );

    ITenant tenantAcme =

        tenantManager.createTenant( systemTenant, TENANT_ID_ACME, tenantAdminRoleName, tenantAuthenticatedRoleName,

            "Anonymous" );

    userRoleDao.createUser( tenantAcme, USERNAME_SUZY, "password", "", new String[] { tenantAdminRoleName } );

    logout();

    login( USERNAME_SUZY, tenantAcme, new String[] { tenantAdminRoleName, tenantAuthenticatedRoleName } );

    final String fileName = "helloworld.[~!@#$%^&*(){}|.,]-=_+|;'?<>~`.sample";

    RepositoryFile newFile =

        createSampleFile( ClientRepositoryPaths.getUserHomeFolderPath( USERNAME_SUZY ), fileName, "blah", false, 123 );

    assertEquals( fileName, newFile.getTitle() );

    RepositoryFile.Builder builder = new RepositoryFile.Builder( newFile );

    final String EN_US_VALUE = "Hello World Sample";

    builder.title( Locale.getDefault().toString(), EN_US_VALUE );

    final String ROOT_LOCALE_VALUE = "Hello World";

    builder.title( RepositoryFile.DEFAULT_LOCALE, ROOT_LOCALE_VALUE );

    final SampleRepositoryFileData modContent = new SampleRepositoryFileData( "blah", false, 123 );

    repo.updateFile( builder.build(), modContent, null );

    RepositoryFile updatedFileWithMaps =

        repo.getFile( ClientRepositoryPaths.getUserHomeFolderPath( USERNAME_SUZY ) + RepositoryFile.SEPARATOR

            + "helloworld.[~!@#$%^&*(){}|.,]-=_+|;'?<>~`.sample", true );

    assertEquals( EN_US_VALUE, updatedFileWithMaps.getLocalePropertiesMap().get( Locale.getDefault().toString() )

        .getProperty( RepositoryFile.FILE_TITLE ) );

    assertEquals( ROOT_LOCALE_VALUE, updatedFileWithMaps.getLocalePropertiesMap().get( RepositoryFile.DEFAULT_LOCALE )

        .getProperty( RepositoryFile.FILE_TITLE ) );

    logout();

  }

  @Test

  public void testLocales() throws Exception {

    login( sysAdminUserName, systemTenant, new String[] { tenantAdminRoleName, tenantAuthenticatedRoleName } );

    ITenant tenantAcme =

        tenantManager.createTenant( systemTenant, TENANT_ID_ACME, tenantAdminRoleName, tenantAuthenticatedRoleName,

            "Anonymous" );

    userRoleDao.createUser( tenantAcme, USERNAME_SUZY, "password", "", new String[] { tenantAdminRoleName } );

    logout();

    login( USERNAME_SUZY, tenantAcme, new String[] { tenantAdminRoleName, tenantAuthenticatedRoleName } );

    // Create file

    final String fileName = "locale.[~!@#$%^&*(){}|.,]-=_+|;'?<>~`.sample";

    RepositoryFile file =

        createSampleFile( ClientRepositoryPaths.getUserHomeFolderPath( USERNAME_SUZY ), fileName, "test", false, 123 );

    // Test filename title matches created file name

    assertEquals( fileName, file.getTitle() );

    final IPentahoLocale SPANISH = new PentahoLocale( new Locale( "es" ) );

    final IPentahoLocale US = new PentahoLocale( Locale.US );

    final String EN_US_TITLE = "Locale Sample";

    final String EN_US_DESCRIPTION = "This is a test for retrieving localized words";

    final String SP_TITLE = "Muestra de Localizacion";

    final String SP_DESCRIPTION = "Esta es una prueba para buscar palabras localizadas";

    RepositoryFile.Builder builder = new RepositoryFile.Builder( file );

    // Set English locale values

    builder.title( US.toString(), EN_US_TITLE );

    builder.description( US.toString(), EN_US_DESCRIPTION );

    // Set Spanish locale values

    builder.title( SPANISH.toString(), SP_TITLE );

    builder.description( SPANISH.toString(), SP_DESCRIPTION );

    // Update file data

    final SampleRepositoryFileData modContent = new SampleRepositoryFileData( "blah", false, 123 );

    repo.updateFile( builder.build(), modContent, null );

    // Retrieve file - gets full map

    RepositoryFile updatedFile = repo.getFile( file.getPath(), true );

    /*

     * Retrieve single result with locale

     */

    // SPANISH

    updatedFile = repo.getFile( file.getPath(), SPANISH );

    assertEquals( SP_TITLE, updatedFile.getTitle() );

    assertEquals( SP_DESCRIPTION, updatedFile.getDescription() );

    // US ENGLISH

    updatedFile = repo.getFile( file.getPath(), US );

    assertEquals( EN_US_TITLE, updatedFile.getTitle() );

    assertEquals( EN_US_DESCRIPTION, updatedFile.getDescription() );

    // ROOT Locale

    updatedFile = repo.getFile( file.getPath(), null );

    assertEquals( EN_US_TITLE, updatedFile.getTitle() );

    assertEquals( EN_US_DESCRIPTION, updatedFile.getDescription() );

    logout();

  }

  @Test

  public void testLocalePropertiesMap() throws Exception {

    login( sysAdminUserName, systemTenant, new String[] { tenantAdminRoleName, tenantAuthenticatedRoleName } );

    ITenant tenantAcme =

        tenantManager.createTenant( systemTenant, TENANT_ID_ACME, tenantAdminRoleName, tenantAuthenticatedRoleName,

            "Anonymous" );

    userRoleDao.createUser( tenantAcme, USERNAME_SUZY, "password", "", new String[] { tenantAdminRoleName } );

    logout();

    login( USERNAME_SUZY, tenantAcme, new String[] { tenantAdminRoleName, tenantAuthenticatedRoleName } );

    // Create file

    final String fileName = "locale.[~!@#$%^&*(){}|.,]-=_+|;'?<>~`.sample";

    RepositoryFile file =

        createSampleFile( ClientRepositoryPaths.getUserHomeFolderPath( USERNAME_SUZY ), fileName, "test", false, 123 );

    // Test filename title matches created file name

    assertEquals( fileName, file.getTitle() );

    final String DEFAULT_LOCALE = "default";

    final IPentahoLocale SPANISH = new PentahoLocale( new Locale( "es" ) );

    final IPentahoLocale US = new PentahoLocale( Locale.US );

    final String TITLE = "title";

    final String DESCRIPTION = "description";

    final String EN_US_TITLE = "Locale Sample";

    final String EN_US_DESCRIPTION = "This is a test for retrieving localized words";

    final String SP_TITLE = "Muestra de Localizacion";

    final String SP_DESCRIPTION = "Esta es una prueba para buscar palabras localizadas";

    RepositoryFile.Builder builder = new RepositoryFile.Builder( file );

    Map<String, Properties> localeMap = new HashMap<String, Properties>();

    // Set English locale values

    final Properties enProperties = new Properties();

    enProperties.setProperty( TITLE, EN_US_TITLE );

    enProperties.setProperty( DESCRIPTION, EN_US_DESCRIPTION );

    localeMap.put( US.toString(), enProperties );

    // Set Spanish locale values

    final Properties esProperties = new Properties();

    esProperties.setProperty( TITLE, SP_TITLE );

    esProperties.setProperty( DESCRIPTION, SP_DESCRIPTION );

    localeMap.put( SPANISH.toString(), esProperties );

    builder.localePropertiesMap( localeMap );

    // Update file data

    final SampleRepositoryFileData modContent = new SampleRepositoryFileData( "blah", false, 123 );

    repo.updateFile( builder.build(), modContent, null );

    // Retrieve file - gets full map

    final RepositoryFile updatedFile = repo.getFile( file.getPath(), true );

    // Assert messages are the same

    Properties ep = updatedFile.getLocalePropertiesMap().get( US.toString() );

    assertEquals( EN_US_TITLE, ep.getProperty( TITLE ) );

    assertEquals( EN_US_DESCRIPTION, ep.getProperty( DESCRIPTION ) );

    Properties sp = updatedFile.getLocalePropertiesMap().get( SPANISH.toString() );

    assertEquals( SP_TITLE, sp.getProperty( TITLE ) );

    assertEquals( SP_DESCRIPTION, sp.getProperty( DESCRIPTION ) );

    // Assert empty rootLocale

    Properties rootLocale = updatedFile.getLocalePropertiesMap().get( DEFAULT_LOCALE );

    assertNotNull( rootLocale );

    final String NEW_TITLE = "new title";

    final String NEW_DESCRIPTION = "new description";

    enProperties.setProperty( TITLE, NEW_TITLE ); // overwrite title

    enProperties.setProperty( DESCRIPTION, NEW_DESCRIPTION ); // overwrite title

    txnTemplate.execute( new TransactionCallbackWithoutResult() {

      public void doInTransactionWithoutResult( final TransactionStatus status ) {

        // assert available locales

        List<Locale> locales = repositoryFileDao.getAvailableLocalesForFile( updatedFile );

        assertEquals( 3, locales.size() ); // includes rootLocale

        // assert correct locale properties

        Properties properties = repositoryFileDao.getLocalePropertiesForFile( updatedFile, "es" );

        assertEquals( SP_TITLE, properties.getProperty( TITLE ) );

        assertEquals( SP_DESCRIPTION, properties.getProperty( DESCRIPTION ) );

        repositoryFileDao.setLocalePropertiesForFile( updatedFile, Locale.US.getLanguage(), enProperties );

      }

    } );

    // Assert updated properties

    RepositoryFile updatedRepoFile = repo.getFile( file.getPath(), true );

    Properties updated_en = updatedRepoFile.getLocalePropertiesMap().get( US.toString() );

    assertEquals( NEW_TITLE, updated_en.getProperty( TITLE ) );

    assertEquals( NEW_DESCRIPTION, updated_en.getProperty( DESCRIPTION ) );

    // test successful delete locale properties

    final RepositoryFile repoFile1 = updatedRepoFile.clone();

    txnTemplate.execute( new TransactionCallbackWithoutResult() {

      public void doInTransactionWithoutResult( final TransactionStatus status ) {

        repositoryFileDao.deleteLocalePropertiesForFile( repoFile1, "es" );

      }

    } );

    // assert deleted locale

    updatedRepoFile = repo.getFile( file.getPath(), true );

    List<Locale> locales = repositoryFileDao.getAvailableLocalesForFile( updatedRepoFile );

    assertEquals( 2, locales.size() );

    // test successful delete locale properties

    final RepositoryFile repoFile2 = updatedRepoFile.clone();

    txnTemplate.execute( new TransactionCallbackWithoutResult() {

      public void doInTransactionWithoutResult( final TransactionStatus status ) {

        repositoryFileDao.deleteLocalePropertiesForFile( repoFile2, "xx" );

      }

    } );

    // locale properties do not exist, no change in available locales

    updatedRepoFile = repo.getFile( file.getPath(), true );

    locales = repositoryFileDao.getAvailableLocalesForFile( updatedRepoFile );

    assertEquals( 2, locales.size() );

    logout();

  }

  /**

   * While they may be filtered from the version history, we still must be able to fetch acl-only changes.

   */

  @Test

  public void testGetAclOnlyVersion() throws Exception {

    login( sysAdminUserName, systemTenant, new String[] { tenantAdminRoleName, tenantAuthenticatedRoleName } );

    ITenant tenantAcme =

        tenantManager.createTenant( systemTenant, TENANT_ID_ACME, tenantAdminRoleName, tenantAuthenticatedRoleName,

            "Anonymous" );

    userRoleDao.createUser( tenantAcme, USERNAME_ADMIN, "password", "", new String[] { tenantAdminRoleName } );

    userRoleDao.createUser( tenantAcme, USERNAME_SUZY, "password", "", null );

    login( USERNAME_SUZY, tenantAcme, new String[] { tenantAuthenticatedRoleName } );

    login( USERNAME_ADMIN, tenantAcme, new String[] { tenantAdminRoleName, tenantAuthenticatedRoleName } );

    defaultBackingRepositoryLifecycleManager.newTenant();

    final String fileName = "helloworld.[~!@#$%^&*(){}|.,]-=_+|;'?<>~`.sample";

    RepositoryFile newFile =

        createSampleFile( ClientRepositoryPaths.getUserHomeFolderPath( USERNAME_SUZY ), fileName, "blah", false, 123,

            true );

    assertEquals( 1, repo.getVersionSummaries( newFile.getId() ).size() );

    RepositoryFileAcl acl = repo.getAcl( newFile.getId() );

    // no change; just want to create a new version

    RepositoryFileAcl updatedAcl = new Builder( acl ).build();

    updatedAcl = repo.updateAcl( updatedAcl );

    assertEquals( 2, repo.getVersionSummaries( newFile.getId() ).size() );

    assertNotNull( repo.getVersionSummary( newFile.getId(), "1.1" ) );

  }

  @Test

  public void testCreateFolder() throws Exception {

    login( sysAdminUserName, systemTenant, new String[] { tenantAdminRoleName, tenantAuthenticatedRoleName } );

    ITenant tenantAcme =

        tenantManager.createTenant( systemTenant, TENANT_ID_ACME, tenantAdminRoleName, tenantAuthenticatedRoleName,

            "Anonymous" );

    userRoleDao.createUser( tenantAcme, USERNAME_ADMIN, "password", "", new String[] { tenantAdminRoleName } );

    login( USERNAME_ADMIN, tenantAcme, new String[] { tenantAdminRoleName, tenantAuthenticatedRoleName } );

    userRoleDao.createUser( tenantAcme, USERNAME_SUZY, "password", "", null );

    login( USERNAME_SUZY, tenantAcme, new String[] { tenantAuthenticatedRoleName } );

    RepositoryFile parentFolder = repo.getFile( ClientRepositoryPaths.getUserHomeFolderPath( USERNAME_SUZY ) );

    RepositoryFile newFolder = new RepositoryFile.Builder( "[~!@#$%^&*(){}|.,]-=_+|;'?<:>~" ).folder( true ).hidden( true ).build();

    Date beginTime = Calendar.getInstance().getTime();

    // Sleep for 1 second for time comparison

    Thread.sleep( 1000 );

    newFolder = repo.createFolder( parentFolder.getId(), newFolder, null );