archiva/archiva-modules/archiva-base/archiva-repository-layer/src/test/java/org/apache/archiva/repository/base/remote/BasicRemoteRepositoryValidatorTest.java

package org.apache.archiva.repository.base.remote;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import org.apache.archiva.common.filelock.DefaultFileLockManager;
import org.apache.archiva.common.filelock.FileLockManager;
import org.apache.archiva.repository.EditableManagedRepository;
import org.apache.archiva.repository.EditableRemoteRepository;
import org.apache.archiva.repository.EditableRepository;
import org.apache.archiva.repository.ManagedRepository;
import org.apache.archiva.repository.RemoteRepository;
import org.apache.archiva.repository.RepositoryException;
import org.apache.archiva.repository.RepositoryRegistry;
import org.apache.archiva.repository.base.ConfigurationHandler;
import org.apache.archiva.repository.base.RepositoryHandlerDependencies;
import org.apache.archiva.repository.base.group.RepositoryGroupHandler;
import org.apache.archiva.repository.base.managed.BasicManagedRepository;
import org.apache.archiva.repository.base.managed.BasicManagedRepositoryValidator;
import org.apache.archiva.repository.mock.ManagedRepositoryContentMock;
import org.apache.archiva.repository.mock.RemoteRepositoryContentMock;
import org.apache.archiva.repository.storage.fs.FilesystemStorage;
import org.apache.archiva.repository.validation.ValidationResponse;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit.jupiter.SpringExtension;

import javax.inject.Inject;
import java.io.IOException;
import java.net.URISyntaxException;
import java.nio.file.Path;
import java.nio.file.Paths;

import static org.junit.jupiter.api.Assertions.*;

/**
 * @author Martin Stockhammer <martin_s@apache.org>
 */
@ExtendWith( SpringExtension.class)
@ContextConfiguration(locations = { "classpath*:/META-INF/spring-context.xml", "classpath:/spring-context.xml" })
class BasicRemoteRepositoryValidatorTest
{

    @Inject
    ConfigurationHandler configurationHandler;

    @Inject
    RepositoryRegistry repositoryRegistry;

    @Inject
    RepositoryHandlerDependencies repositoryHandlerDependencies;

    Path repoBaseDir;

    @AfterEach
    void cleanup() {
        try
        {
            repositoryRegistry.removeRepository( "test" );
        }
        catch ( RepositoryException e )
        {
            // Ignore this
        }

    }

    protected EditableRemoteRepository createRepository( String id, String name, Path location ) throws IOException
    {
        FileLockManager lockManager = new DefaultFileLockManager();
        FilesystemStorage storage = new FilesystemStorage(location.toAbsolutePath(), lockManager);
        BasicRemoteRepository repo = new BasicRemoteRepository(id, name, storage);
        repo.setLocation( location.toAbsolutePath().toUri());
        repo.setContent(new RemoteRepositoryContentMock());
        return repo;
    }

    private Path getRepoBaseDir() {
        if (repoBaseDir==null) {
            try
            {
                repoBaseDir = Paths.get(Thread.currentThread( ).getContextClassLoader( ).getResource( "repositories" ).toURI());
            }
            catch ( URISyntaxException e )
            {
                throw new RuntimeException( "Could not retrieve repository base directory" );
            }
        }
        return repoBaseDir;
    }


    @Test
    void apply( ) throws IOException
    {
        BasicRemoteRepositoryValidator validator = new BasicRemoteRepositoryValidator( configurationHandler );
        validator.setRepositoryRegistry( repositoryRegistry );
        Path repoDir = getRepoBaseDir().resolve("test" );
        EditableRemoteRepository repo = createRepository( "test", "test", repoDir );
        ValidationResponse<RemoteRepository> result = validator.apply( repo );
        assertTrue( result.isValid( ) );
    }

    @Test
    void applyWithExistingRepo( ) throws IOException, RepositoryException
    {
        BasicRemoteRepositoryValidator validator = new BasicRemoteRepositoryValidator( configurationHandler );
        validator.setRepositoryRegistry( repositoryRegistry );
        Path repoDir = getRepoBaseDir().resolve("test" );
        EditableRemoteRepository repo = createRepository( "test", "test", repoDir );
        Path repoDir2 = getRepoBaseDir().resolve("test2" );
        EditableRemoteRepository repo2 = createRepository( "test", "test", repoDir2 );
        repositoryRegistry.putRepository( repo );
        ValidationResponse<RemoteRepository> result = validator.apply( repo );
        assertFalse( result.isValid( ) );
        assertEquals( 1, result.getResult( ).size( ) );
        assertTrue( result.getResult( ).containsKey( "id" ) );
        assertEquals( "remote_repository", result.getResult( ).get( "id" ).get( 0 ).getCategory( ) );
        assertEquals( "remote_repo_exists", result.getResult( ).get( "id" ).get( 0 ).getType( ) );
        assertEquals( "id", result.getResult( ).get( "id" ).get( 0 ).getAttribute() );
    }

    @Test
    void applyUpdateWithExistingRepo( ) throws IOException, RepositoryException
    {
        BasicRemoteRepositoryValidator validator = new BasicRemoteRepositoryValidator( configurationHandler );
        validator.setRepositoryRegistry( repositoryRegistry );
        Path repoDir = getRepoBaseDir().resolve("test" );
        EditableRemoteRepository repo = createRepository( "test", "test", repoDir );
        Path repoDir2 = getRepoBaseDir().resolve("test2" );
        EditableRemoteRepository repo2 = createRepository( "test", "test", repoDir2 );
        repositoryRegistry.putRepository( repo );
        ValidationResponse<RemoteRepository> result = validator.applyForUpdate( repo );
        assertTrue( result.isValid( ) );
        assertEquals( 0, result.getResult( ).size( ) );
    }

    @Test
    void applyWithNullObject( ) throws IOException
    {
        BasicRemoteRepositoryValidator validator = new BasicRemoteRepositoryValidator( configurationHandler );
        validator.setRepositoryRegistry( repositoryRegistry );
        ValidationResponse<RemoteRepository> result = validator.apply( null );
        assertFalse( result.isValid( ) );
        assertEquals( 1, result.getResult( ).size( ) );
        assertTrue( result.getResult( ).containsKey( "object" ) );
        assertEquals( "remote_repository", result.getResult( ).get( "object" ).get( 0 ).getCategory( ) );
        assertEquals( "isnull", result.getResult( ).get( "object" ).get( 0 ).getType( ) );
        assertEquals( "object", result.getResult( ).get( "object" ).get( 0 ).getAttribute() );
    }

    @Test
    void applyWithEmptyId( ) throws IOException
    {
        BasicRemoteRepositoryValidator validator = new BasicRemoteRepositoryValidator( configurationHandler );
        validator.setRepositoryRegistry( repositoryRegistry );
        Path repoDir = getRepoBaseDir().resolve("test" );
        EditableRemoteRepository repo = createRepository( "", "test", repoDir );
        ValidationResponse<RemoteRepository> result = validator.apply( repo );
        assertFalse( result.isValid( ) );
        assertEquals( 1, result.getResult( ).size( ) );
        assertTrue( result.getResult( ).containsKey( "id" ) );
        assertEquals( "remote_repository", result.getResult( ).get( "id" ).get( 0 ).getCategory( ) );
        assertEquals( "empty", result.getResult( ).get( "id" ).get( 0 ).getType( ) );
        assertEquals( "id", result.getResult( ).get( "id" ).get( 0 ).getAttribute() );
    }

    @Test
    void applyWithBadName( ) throws IOException
    {
        BasicRemoteRepositoryValidator validator = new BasicRemoteRepositoryValidator( configurationHandler );
        validator.setRepositoryRegistry( repositoryRegistry );
        Path repoDir = getRepoBaseDir().resolve("test" );
        EditableRemoteRepository repo = createRepository( "test", "badtest\\name", repoDir );
        ValidationResponse<RemoteRepository> result = validator.apply( repo );
        assertFalse( result.isValid( ) );
        assertEquals( 1, result.getResult( ).size( ) );
        assertEquals( "invalid_chars", result.getResult( ).get( "name" ).get( 0 ).getType( ) );
    }

    @Test
    void applyWithBadSchedulingExpression( ) throws IOException
    {
        BasicRemoteRepositoryValidator validator = new BasicRemoteRepositoryValidator( configurationHandler );
        validator.setRepositoryRegistry( repositoryRegistry );
        Path repoDir = getRepoBaseDir().resolve("test" );
        EditableRemoteRepository repo = createRepository( "test", "test", repoDir );
        repo.setSchedulingDefinition( "xxxxx" );
        ValidationResponse<RemoteRepository> result = validator.apply( repo );
        assertFalse( result.isValid( ) );
        assertEquals( 1, result.getResult( ).size( ) );
        assertEquals( "invalid_scheduling_exp", result.getResult( ).get( "scheduling_definition" ).get( 0 ).getType( ) );
    }

    @Test
    void applyForUpdate( )
    {
    }

    @Test
    void getFlavour( )
    {
        BasicRemoteRepositoryValidator validator = new BasicRemoteRepositoryValidator( configurationHandler );
        validator.setRepositoryRegistry( repositoryRegistry );
        assertEquals( RemoteRepository.class, validator.getFlavour( ) );
    }

    @Test
    void isFlavour( )
    {
        BasicRemoteRepositoryValidator validator = new BasicRemoteRepositoryValidator( configurationHandler );
        validator.setRepositoryRegistry( repositoryRegistry );
        assertTrue( validator.isFlavour( RemoteRepository.class ) );
        assertTrue( validator.isFlavour( BasicRemoteRepository.class ) );
    }
}