MockDataCreators.java

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014 Andreas Alanko, Emil Nilsson, Sony Mobile Communications AB.
 * All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.sonymobile.jenkins.plugins.gitlab.gitlabauth.helpers;

import com.sonymobile.gitlab.model.GitLabGroupInfo;
import com.sonymobile.jenkins.plugins.gitlab.gitlabauth.authorization.GitLabFolderAuthorization;
import org.easymock.IAnswer;
import org.powermock.api.easymock.PowerMock;
import org.powermock.modules.junit4.PowerMockRunner;

import static org.easymock.EasyMock.anyInt;
import static org.easymock.EasyMock.createMock;
import static org.easymock.EasyMock.createNiceMock;
import static org.easymock.EasyMock.expect;
import static org.easymock.EasyMock.getCurrentArguments;
import static org.easymock.EasyMock.replay;
import static org.powermock.api.easymock.PowerMock.expectNew;

/**
 * Helper methods for creating mock data for tests.
 *
 * @author Emil Nilsson
 */
public class MockDataCreators {
    private MockDataCreators() { /* empty */}

    /**
     * Mocks a folder authorization property object.
     *
     * @param groupId the group ID for the GitLab group
     * @return a folder property object
     */
    public static GitLabFolderAuthorization mockFolderAuthorization(int groupId) {
        GitLabFolderAuthorization folderAuthorization = createMock(GitLabFolderAuthorization.class);
        expect(folderAuthorization.getGroupId()).andReturn(groupId).anyTimes();
        replay(folderAuthorization);

        return folderAuthorization;
    }

    /**
     * Mocks a folder authorization property object.
     *
     * @param groupId the group ID
     * @param name    the group name
     * @param path    the path for the group
     * @return a folder property object
     */
    public static GitLabFolderAuthorization mockFolderAuthorization(int groupId, String name, String path) {
        try {
            GitLabFolderAuthorization folderAuthorization = createMock(GitLabFolderAuthorization.class);
            expect(folderAuthorization.getGroupId()).andReturn(groupId).anyTimes();
            expect(folderAuthorization.getFolderName()).andReturn(path).anyTimes();
            expect(folderAuthorization.getGroupName()).andReturn(name).anyTimes();
            expect(folderAuthorization.getGroupPath()).andReturn(path).anyTimes();
            expect(folderAuthorization.getGroup()).andReturn(mockGroupInfo(groupId, name, path)).anyTimes();
            replay(folderAuthorization);

            return folderAuthorization;
        } catch (Exception e) {
            // not expected to throw an exception, rethrow as runtime exception
            throw new RuntimeException(e);
        }
    }

    /**
     * Mocks a GitLab group info object.
     *
     * @param groupId the group ID
     * @param name    the group name
     * @param path    the path for the group
     * @return a group info object
     */
    public static GitLabGroupInfo mockGroupInfo(int groupId, String name, String path) {
        GitLabGroupInfo groupInfo = createNiceMock(GitLabGroupInfo.class);
        expect(groupInfo.getId()).andReturn(groupId).anyTimes();
        expect(groupInfo.getName()).andReturn(name).anyTimes();
        expect(groupInfo.getPath()).andReturn(path).anyTimes();
        replay(groupInfo);

        return groupInfo;
    }

    /**
     * Mocks the constructor of {@link GitLabFolderAuthorization}.
     *
     * Mocks constructor calls to {@link GitLabFolderAuthorization} with an int parameter returning a mock folder
     * authorization object from {@link #mockFolderAuthorization(int)}.
     *
     * Note: the test class must run with {@link PowerMockRunner} and prepare the {@link GitLabFolderAuthorization}
     * class and the class invoking the constructor for testing with PowerMock.
     */
    public static void expectNewFolderAuthorization() {
        try {
            // create a new mock folder authorization with the groupId parameter when the constructor is invoked
            expectNew(GitLabFolderAuthorization.class, anyInt())
                    .andAnswer(new IAnswer<GitLabFolderAuthorization>() {
                        public GitLabFolderAuthorization answer() throws Throwable {
                            return mockFolderAuthorization((Integer)getCurrentArguments()[0]);
                        }
                    }).anyTimes();
            PowerMock.replay(GitLabFolderAuthorization.class);
        } catch (Exception e) {
            // not expected to throw an exception, rethrow as runtime exception
            throw new RuntimeException(e);
        }
    }
}