PoolResourceTest.java example

Explorer
candlepin-master
/**
 * Copyright (c) 2009 - 2012 Red Hat, Inc.
 *
 * This software is licensed to you under the GNU General Public License,
 * version 2 (GPLv2). There is NO WARRANTY for this software, express or
 * implied, including the implied warranties of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. You should have received a copy of GPLv2
 * along with this software; if not, see
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
 *
 * Red Hat trademarks are not licensed under GPLv2. No permission is
 * granted to use or replicate Red Hat trademarks that are incorporated
 * in this software or its documentation.
 */
package org.candlepin.resource;

import static org.junit.Assert.*;
import static org.mockito.Matchers.*;
import static org.mockito.Mockito.*;

import org.candlepin.auth.Access;
import org.candlepin.auth.ConsumerPrincipal;
import org.candlepin.auth.Principal;
import org.candlepin.common.exceptions.BadRequestException;
import org.candlepin.common.exceptions.ForbiddenException;
import org.candlepin.common.exceptions.NotFoundException;
import org.candlepin.controller.CandlepinPoolManager;
import org.candlepin.model.Consumer;
import org.candlepin.model.Entitlement;
import org.candlepin.model.Owner;
import org.candlepin.model.Pool;
import org.candlepin.model.Product;
import org.candlepin.resource.util.CalculatedAttributesUtil;
import org.candlepin.test.DatabaseTestFixture;
import org.candlepin.test.TestUtil;

import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.xnap.commons.i18n.I18n;

import java.util.Date;
import java.util.List;

import javax.inject.Inject;


/**
 * PoolResourceTest
 */
public class PoolResourceTest extends DatabaseTestFixture {
    @Inject private I18n i18n;
    @Inject private CandlepinPoolManager poolManager;

    private Owner owner1;
    private Owner owner2;
    private Pool pool1;
    private Pool pool2;
    private Pool pool3;
    private Product product1;
    private Product product1Owner2;
    private Product product2;
    private PoolResource poolResource;
    private static final String PRODUCT_CPULIMITED = "CPULIMITED001";
    private Consumer failConsumer;
    private Consumer passConsumer;
    private Consumer foreignConsumer;
    private static final int START_YEAR = 2000;
    private static final int END_YEAR = 3000;
    private Principal adminPrincipal;

    @Mock private CalculatedAttributesUtil attrUtil;

    @Before
    public void setUp() {
        MockitoAnnotations.initMocks(this);

        owner1 = createOwner();
        owner2 = createOwner();
        ownerCurator.create(owner1);
        ownerCurator.create(owner2);

        product1 = this.createProduct(PRODUCT_CPULIMITED, PRODUCT_CPULIMITED, owner1);
        product1Owner2 = this.createProduct(PRODUCT_CPULIMITED, PRODUCT_CPULIMITED, owner2);
        product2 = this.createProduct(owner1);

        pool1 = createPool(owner1, product1, 500L,
             TestUtil.createDate(START_YEAR, 1, 1), TestUtil.createDate(END_YEAR, 1, 1));
        pool2 = createPool(owner1, product2, 500L,
             TestUtil.createDate(START_YEAR, 1, 1), TestUtil.createDate(END_YEAR, 1, 1));
        pool3 = createPool(owner2 , product1Owner2, 500L,
             TestUtil.createDate(START_YEAR, 1, 1), TestUtil.createDate(END_YEAR, 1, 1));
        poolCurator.create(pool1);
        poolCurator.create(pool2);
        poolCurator.create(pool3);

        poolResource = new PoolResource(consumerCurator, ownerCurator, i18n, poolManager, attrUtil);

        // Consumer system with too many cpu cores:

        failConsumer = TestUtil.createConsumer(createOwner());
        failConsumer.setFact("cpu_cores", "4");
        consumerTypeCurator.create(failConsumer.getType());
        consumerCurator.create(failConsumer);

        // Consumer system with appropriate number of cpu cores:
        passConsumer = TestUtil.createConsumer(owner1);
        passConsumer.setFact("cpu_cores", "2");
        consumerTypeCurator.create(passConsumer.getType());
        consumerCurator.create(passConsumer);

        foreignConsumer = TestUtil.createConsumer(owner2);
        foreignConsumer.setFact("cpu_cores", "2");
        consumerTypeCurator.create(foreignConsumer.getType());
        consumerCurator.create(foreignConsumer);

        // Run most of these tests as an owner admin:
        adminPrincipal = setupPrincipal(owner1, Access.ALL);
    }

    @Test(expected = ForbiddenException.class)
    public void testUserCannotListAllPools() {
        List<Pool> pools = poolResource.list(null, null, null, false, null, adminPrincipal, null);
        assertEquals(3, pools.size());
    }

    @Test
    public void testListAll() {
        List<Pool> pools = poolResource.list(null, null, null, false, null,
            setupAdminPrincipal("superadmin"), null);
        assertEquals(3, pools.size());
    }

    @Test
    public void testListForOrg() {
        List<Pool> pools = poolResource.list(owner1.getId(), null, null, false, null, adminPrincipal, null);
        assertEquals(2, pools.size());
        Principal p = setupPrincipal(owner2, Access.ALL);
        pools = poolResource.list(owner2.getId(), null, null, false, null, p, null);
        assertEquals(1, pools.size());
    }

    @Ignore
    @Test
    public void testListForProduct() {
        List<Pool> pools = poolResource.list(null, null, product1.getId(), false, null, adminPrincipal, null);
        assertEquals(2, pools.size());
        pools = poolResource.list(null, null, product2.getId(), false, null,
            adminPrincipal, null);
        assertEquals(1, pools.size());
    }

    @Test
    public void testListForOrgAndProduct() {
        List<Pool> pools = poolResource.list(owner1.getId(), null, product1.getId(), false,
            null, adminPrincipal, null);
        assertEquals(1, pools.size());
    }

    @Test(expected = NotFoundException.class)
    public void testCannotListPoolsInAnotherOwner() {
        List<Pool> pools = poolResource.list(owner2.getId(), null, product2.getId(),
            false, null, adminPrincipal, null);
        assertEquals(0, pools.size());
    }

    @Test
    public void testListConsumerAndProductFiltering() {
        List<Pool> pools = poolResource.list(null, passConsumer.getUuid(),
            product1.getId(), false, null, adminPrincipal, null);
        assertEquals(1, pools.size());

        verify(attrUtil, times(1)).setCalculatedAttributes(eq(pools), any(Date.class));
    }

    @Test(expected = NotFoundException.class)
    public void testCannotListPoolsForConsumerInAnotherOwner() {
        List<Pool> pools = poolResource.list(null, failConsumer.getUuid(),
            product1.getId(), false, null, adminPrincipal, null);
        assertEquals(0, pools.size());
    }

    // Filtering by both a consumer and an owner makes no sense (we should use the
    // owner of that consumer), so make sure we error if someone tries.
    @Test(expected = BadRequestException.class)
    public void testListBlocksConsumerOwnerFiltering() {
        poolResource.list(owner1.getId(), passConsumer.getUuid(),
            product1.getId(), false, null, adminPrincipal, null);
    }

    @Test
    public void testListConsumerFiltering() {
        setupPrincipal(new ConsumerPrincipal(passConsumer));
        List<Pool> pools = poolResource.list(null, passConsumer.getUuid(), null, false,
            null, adminPrincipal, null);
        assertEquals(2, pools.size());

        verify(attrUtil, times(1)).setCalculatedAttributes(eq(pools), any(Date.class));
    }

    @Test(expected = NotFoundException.class)
    public void testListNoSuchOwner() {
        poolResource.list("-1", null, null, false, null, adminPrincipal, null);
    }

    @Test(expected = NotFoundException.class)
    public void testListNoSuchConsumer() {
        poolResource.list(null, "blah", null, false, null, adminPrincipal, null);
    }

    @Test
    public void testListNoSuchProduct() {
        assertEquals(0, poolResource.list(owner1.getId(), null, "boogity", false,
            null, adminPrincipal, null).size());
    }

    @Test(expected = NotFoundException.class)
    public void ownerAdminCannotListAnotherOwnersPools() {
        List<Pool> pools = poolResource.list(owner1.getId(), null, null, false, null,
            adminPrincipal, null);
        assertEquals(2, pools.size());

        Principal anotherPrincipal = setupPrincipal(owner2, Access.ALL);
        securityInterceptor.enable();

        poolResource.list(owner1.getId(), null, null, false, null, anotherPrincipal, null);
    }


    @Test(expected = NotFoundException.class)
    public void testConsumerCannotListPoolsForAnotherOwnersConsumer() {
        Principal p = setupPrincipal(new ConsumerPrincipal(foreignConsumer));
        securityInterceptor.enable();

        poolResource.list(null, passConsumer.getUuid(), null, false, null, p, null);
    }

    @Test(expected = NotFoundException.class)
    public void consumerCannotListPoolsForAnotherOwner() {
        Principal p = setupPrincipal(new ConsumerPrincipal(foreignConsumer));
        securityInterceptor.enable();

        poolResource.list(owner1.getId(), null, null, false, null, p, null);
    }

    @Test
    public void consumerCanListOwnersPools() {
        Principal p = setupPrincipal(new ConsumerPrincipal(passConsumer));
        securityInterceptor.enable();

        poolResource.list(owner1.getId(), null, null, false, null, p, null);
    }

    @Test(expected = BadRequestException.class)
    public void testBadActiveOnDate() {
        poolResource.list(owner1.getId(), null, null, false, "bc", adminPrincipal, null);
    }

    @Test
    public void testActiveOnDate() {
        // Need to be a super admin to do this:
        String activeOn = Integer.toString(START_YEAR + 1);
        List<Pool> pools = poolResource.list(null, null, null, false, activeOn,
            setupAdminPrincipal("superadmin"), null);
        assertEquals(3, pools.size());

        activeOn = Integer.toString(START_YEAR - 1);
        pools = poolResource.list(owner1.getId(), null, null, false, activeOn,
            adminPrincipal, null);
        assertEquals(0, pools.size());
    }

    @Test
    public void testCalculatedAttributesEmpty() {
        Pool p = poolResource.getPool(pool1.getId(), null, null, adminPrincipal);
        assertTrue(p.getCalculatedAttributes().isEmpty());
    }

    @Test(expected = NotFoundException.class)
    public void testUnauthorizedUserRequestingPool() {
        Owner owner2 = createOwner();
        ownerCurator.create(owner2);
        poolResource.getPool(pool1.getId(), passConsumer.getUuid(),
            null, setupPrincipal(owner2, Access.NONE));
    }

    @Test(expected = NotFoundException.class)
    public void testUnknownConsumerRequestingPool() {
        poolResource.getPool(pool1.getId(), "xyzzy", null, adminPrincipal);
    }

    public void testEmptyEntitlementList() {
        List<Entitlement> ents =
            poolResource.getPoolEntitlements(pool1.getId(),  adminPrincipal);
        assertEquals(0, ents.size());
    }

    @Test(expected = NotFoundException.class)
    public void testUnknownConsumerRequestingEntitlements() {
        poolResource.getPoolEntitlements("xyzzy", adminPrincipal);
    }
}