package jmri.jmrix;

import java.util.List;

import jmri.*;
import jmri.util.JUnitUtil;

import org.junit.Assert;
import org.junit.Assume;
import org.junit.jupiter.api.*;

import javax.annotation.Nonnull;

/**
 * JUnit tests for the AbstractProgrammer class
 * <p>
 * Copyright: Copyright (c) 2002</p>
 *
 * @author Bob Jacobsen
 */
public class AbstractProgrammerTest extends ProgrammerTestBase {

    @Test
    public void testDefaultViaBestMode() {
        Assume.assumeTrue(programmer instanceof AbstractProgrammer);
        Assert.assertEquals("Check Default", ProgrammingMode.DIRECTMODE,
                ((AbstractProgrammer)programmer).getBestMode());        
    }
    
    @Test
    public void testRegisterFromCV() {
        Assume.assumeTrue(programmer instanceof AbstractProgrammer);
        AbstractProgrammer abstractprogrammer = (AbstractProgrammer) programmer;
        int cv1 = -1;

        try {
            Assert.assertEquals("test CV 1", 1,
                    abstractprogrammer.registerFromCV(cv1 = 1));
            Assert.assertEquals("test CV 2", 2,
                    abstractprogrammer.registerFromCV(cv1 = 2));
            Assert.assertEquals("test CV 3", 3,
                    abstractprogrammer.registerFromCV(cv1 = 3));
            Assert.assertEquals("test CV 4", 4,
                    abstractprogrammer.registerFromCV(cv1 = 4));
            Assert.assertEquals("test CV 29", 5,
                    abstractprogrammer.registerFromCV(cv1 = 29));
            Assert.assertEquals("test CV 7", 7,
                    abstractprogrammer.registerFromCV(cv1 = 7));
            Assert.assertEquals("test CV 8", 8,
                    abstractprogrammer.registerFromCV(cv1 = 8));
        } catch (ProgrammerException e) {
            Assert.fail("unexpected exception while cv = " + cv1);
        }

        // now try for some exceptions
        for (cv1 = 5; cv1 < 29; cv1++) {
            if (cv1 == 7 || cv1 == 8) {
                continue;
            }
            try {
                abstractprogrammer.registerFromCV(cv1); // should assert
                Assert.fail("did not throw as expected for cv = " + cv1);
            } catch (ProgrammerException e) {
                jmri.util.JUnitAppender.assertWarnMessage("Unhandled register from cv:  "+cv1);
            }
        }
    }

    @BeforeEach
    @Override
    public void setUp() {
        JUnitUtil.setUp();

        programmer = new AbstractProgrammer() {

            @Nonnull
            @Override
            public List<ProgrammingMode> getSupportedModes() {
                java.util.ArrayList<ProgrammingMode> retval = new java.util.ArrayList<>();
                
                retval.add(ProgrammingMode.DIRECTMODE);
                retval.add(ProgrammingMode.PAGEMODE);
                retval.add(ProgrammingMode.REGISTERMODE);

                return retval;
            }
  
            // Programmer implementation that uses getBestMode for setting default
            @Override
            public ProgrammingMode getBestMode() { return ProgrammingMode.DIRECTMODE; }

            @Override
            public void writeCV(String i, int j, ProgListener l) {}
            @Override
            public void confirmCV(String i, int j, ProgListener l) {}
            @Override
            public void readCV(String i, ProgListener l) {}
            @Override
            public void timeout() {}
            @Override
            public boolean getCanRead() { return true;}
        };
    }

    @AfterEach
    @Override
    public void tearDown() {
        programmer = null;
        JUnitUtil.tearDown();
    }

}