/*
 * Units of Measurement TCK
 * Copyright © 2005-2023, Jean-Marie Dautelle, Werner Keil, Otavio Santana.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
 *    and the following disclaimer in the documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of JSR-385 nor the names of its contributors may be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package tech.units.tck.tests.spi;

import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertNotNull;
import static tech.units.tck.TCKRunner.MEASURE_PACKAGE;
import static tech.units.tck.TCKRunner.SECTION_PREFIX;
import static tech.units.tck.TCKRunner.SPEC_ID;
import static tech.units.tck.TCKRunner.SPEC_VERSION;
import static tech.units.tck.util.TestGroups.SPI;

import java.util.Set;

import javax.measure.Quantity;
import javax.measure.Unit;
import javax.measure.format.QuantityFormat;
import javax.measure.spi.QuantityFactory;
import javax.measure.spi.ServiceProvider;
import javax.measure.spi.SystemOfUnits;

import org.jboss.test.audit.annotations.SpecAssertion;
import org.jboss.test.audit.annotations.SpecVersion;
import org.reflections.Reflections;
import org.testng.annotations.Test;

import tech.units.tck.util.TestUtils;

/**
 * Test class for creating new quantities.
 * @author Werner Keil
 * @author Almas Shaikh
 * @version 2.2, July 7, 2023
 * @since 1.0
 */
@SpecVersion(spec = SPEC_ID, version = SPEC_VERSION)
public class ObtainingQuantiesTest {
    private static final String SECTION_NUM = "5.6.1";

    // ************************ 5.6 Obtaining Quantity Instances
    // ************************
    /**
     * Access a QuantityFactory for each registered type.
     */
    @SuppressWarnings({ "unchecked", "rawtypes" })
    @Test(groups = {"spi"}, description = SECTION_NUM + " Quantities Obtained from a factory")
    @SpecAssertion(section = SECTION_NUM, id = "561-A1")
    public void testAccessToQuantityFactory() {
        Reflections reflections = new Reflections(MEASURE_PACKAGE);
        Set<Class<? extends Quantity>> subTypes = reflections.getSubTypesOf(Quantity.class);
        for (Class clazz : subTypes) {
            QuantityFactory<?> factory = ServiceProvider.current().getQuantityFactory(clazz);
            assertNotNull(factory, SECTION_PREFIX + SECTION_NUM + ": No QuantityFactory available for " + clazz.getSimpleName());
        }
    }

    /**
     * Check a QuantityFactory for each registered type has create method.
     */
    @SuppressWarnings({ "rawtypes", "unchecked" })
    @Test(groups = { SPI }, description = SECTION_NUM + " Quantities obtained from a factory has create method")
    @SpecAssertion(section = SECTION_NUM, id = "561-A2")
    public void testAccessToQuantityFactoryCreate() {
        Reflections reflections = new Reflections(MEASURE_PACKAGE);
        Set<Class<? extends Quantity>> subTypes = reflections.getSubTypesOf(Quantity.class);
        for (Class clazz : subTypes) {
            QuantityFactory<?> factory = ServiceProvider.current().getQuantityFactory(clazz);
            TestUtils.testHasPublicMethod(SECTION_PREFIX + SECTION_NUM, factory.getClass(), Quantity.class, "create", Number.class, Unit.class);
        }
    }

    /**
     * Check a QuantityFactory for each registered type has getSystemUnit method.
     */
    @SuppressWarnings({ "rawtypes", "unchecked" })
    @Test(groups = { SPI }, description = SECTION_NUM + " Quantities obtained from a factory has getSystemUnit method")
    @SpecAssertion(section = SECTION_NUM, id = "561-A3")
    public void testAccessToQuantityFactoryGetSystemUnit() {
        Reflections reflections = new Reflections(MEASURE_PACKAGE);
        Set<Class<? extends Quantity>> subTypes = reflections.getSubTypesOf(Quantity.class);
        for (Class clazz : subTypes) {
            QuantityFactory<?> factory = ServiceProvider.current().getQuantityFactory(clazz);
            TestUtils.testHasPublicMethod(SECTION_PREFIX + SECTION_NUM, factory.getClass(), Unit.class, "getSystemUnit");
        }
    }

    /**
     * Try parsing a quantity string for each registered unit.
     * @since 2.1
     */
    @SuppressWarnings("rawtypes")
    @Test(groups = { SPI }, description = SECTION_NUM
            + " Quantities obtained by string parsing")
    @SpecAssertion(section = SECTION_NUM, id = "561-A4")
    public void testGetQuantitiesFromString() {
        final QuantityFormat format = ServiceProvider.current().getFormatService().getQuantityFormat();
                for (SystemOfUnits sou : ServiceProvider.current()
                        .getSystemOfUnitsService().getAvailableSystemsOfUnits()) {
                    for (Unit u : sou.getUnits()) {
                        assertNotNull(u, SECTION_PREFIX + SECTION_NUM + ": A Unit is missing from " + sou.getName());
                                if (u.getSymbol() != null) {
                                    String s = u.toString();
                                    Quantity q = format.parse("1 " + s);
                                    assertEquals(u, q.getUnit(), SECTION_PREFIX + SECTION_NUM + ": Quantity unit could not be parsed for '" + s + "'");
                                    assertEquals(1, q.getValue().doubleValue(), 0, SECTION_PREFIX + SECTION_NUM + ": Quantity value could not be parsed for '" + s + "'");
                                }
                    }
                }
    }
}