TestCatalog.java

/*
 * Copyright 2010-2013 Ning, Inc.
 * Copyright 2014 Groupon, Inc
 * Copyright 2014 The Billing Project, LLC
 *
 * The Billing Project 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.
 */

package org.killbill.billing.jaxrs;

import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.killbill.billing.client.model.Catalog;
import org.killbill.billing.client.model.Plan;
import org.killbill.billing.client.model.PlanDetail;
import org.killbill.billing.client.model.Product;
import org.killbill.billing.util.jackson.ObjectMapper;
import org.testng.Assert;
import org.testng.annotations.Test;

import com.google.common.io.Resources;

public class TestCatalog extends TestJaxrsBase {

    @Test(groups = "slow", description = "Upload and retrieve a per tenant catalog")
    public void testMultiTenantCatalog() throws Exception {
        final String catalogPath = Resources.getResource("SpyCarBasic.xml").getPath();
        killBillClient.uploadXMLCatalog(catalogPath, createdBy, reason, comment);

        final String catalog = killBillClient.getXMLCatalog();
        Assert.assertNotNull(catalog);
    }

    @Test(groups = "slow", description = "Can retrieve the full catalog as JSON, see https://github.com/killbill/killbill/issues/272")
    public void testFullCatalogJSON() throws Exception {
        final String jsonCatalog = killBillClient.getJSONCatalog();
        // Verify we can serialize the StandaloneCatalog as JSON. While we usually never serialize
        // directly API objects (we always transform them in the JAX-RS layer), this is a good
        // regression test to make sure there are no loops and/or exceptions going through all
        // the getters, which can be problematic in the Ruby bridge (see in particular
        // https://github.com/killbill/killbill-java-parser/issues/6 and https://github.com/killbill/killbill-java-parser/issues/7).
        // We don't attempt to de-serialize it back however because there is not enough information
        // for Jackson (e.g. which concrete implementation of catalog objects to use). If we want to support
        // this one day, we will need a translation layer in JAX-RS for all catalog objects.
        final Map standaloneCatalog = new ObjectMapper().readValue(jsonCatalog, Map.class);
        Assert.assertEquals(standaloneCatalog.get("catalogName"), "Firearms");
        Assert.assertEquals(standaloneCatalog.get("recurringBillingMode"), "IN_ADVANCE");
        Assert.assertEquals(standaloneCatalog.get("effectiveDate"), "2011-01-01T00:00:00.000+0000");
        Assert.assertEquals(((List) standaloneCatalog.get("currentSupportedCurrencies")).size(), 3);
        Assert.assertEquals(((List) standaloneCatalog.get("currentProducts")).size(), 11);
        Assert.assertEquals(((List) standaloneCatalog.get("currentPlans")).size(), 20);
        Assert.assertEquals(((List) standaloneCatalog.get("currentUnits")).size(), 1);
    }

    @Test(groups = "slow", description = "Can retrieve a simplified version of the catalog")
    public void testCatalogSimple() throws Exception {
        final Set<String> allBasePlans = new HashSet<String>();

        final Catalog catalogJsonSimple = killBillClient.getSimpleCatalog();
        for (final Product productJson : catalogJsonSimple.getProducts()) {
            if (!"BASE".equals(productJson.getType())) {
                Assert.assertEquals(productJson.getIncluded().size(), 0);
                Assert.assertEquals(productJson.getAvailable().size(), 0);
                continue;
            }

            // Save all plans for later (see below)
            for (final Plan planJson : productJson.getPlans()) {
                allBasePlans.add(planJson.getName());
            }

            // Retrieve available products (addons) for that base product
            final List<PlanDetail> availableAddons = killBillClient.getAvailableAddons(productJson.getName());
            final Set<String> availableAddonsNames = new HashSet<String>();
            for (final PlanDetail planDetailJson : availableAddons) {
                availableAddonsNames.add(planDetailJson.getProduct());
            }
            Assert.assertEquals(availableAddonsNames, new HashSet<String>(productJson.getAvailable()));
        }

        // Verify base plans endpoint
        final List<PlanDetail> basePlans = killBillClient.getBasePlans();
        final Set<String> foundBasePlans = new HashSet<String>();
        for (final PlanDetail planDetailJson : basePlans) {
            foundBasePlans.add(planDetailJson.getPlan());
        }
        Assert.assertEquals(foundBasePlans, allBasePlans);
    }
}