mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-21 01:01:43 +00:00
Removed @author from comments (#88)
Keeping @author lines in the comments serves no functional purpose.
This commit is contained in:
committed by
Peter Johnson
parent
7a402b4170
commit
2f7eff7091
@@ -26,8 +26,6 @@ import static org.junit.Assert.assertThat;
|
||||
/**
|
||||
* This class should not be run as a test explicitly. Instead it should be extended by tests that
|
||||
* use the InterruptableSensorBase.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public abstract class AbstractInterruptTest extends AbstractComsSetup {
|
||||
private InterruptableSensorBase m_interruptable = null;
|
||||
|
||||
@@ -24,8 +24,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Test that covers the {@link AnalogCrossConnectFixture}.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class AnalogCrossConnectTest extends AbstractInterruptTest {
|
||||
private static final Logger logger = Logger.getLogger(AnalogCrossConnectTest.class.getName());
|
||||
|
||||
@@ -22,8 +22,6 @@ import static org.junit.Assert.assertEquals;
|
||||
|
||||
/**
|
||||
* Tests the {@link AnalogPotentiometer}.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class AnalogPotentiometerTest extends AbstractComsSetup {
|
||||
private static final Logger logger = Logger.getLogger(AnalogPotentiometerTest.class.getName());
|
||||
|
||||
@@ -27,8 +27,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Tests to see if the Counter is working properly.
|
||||
*
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
@RunWith(Parameterized.class)
|
||||
public class CounterTest extends AbstractComsSetup {
|
||||
|
||||
@@ -25,8 +25,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Tests to see if the Digital ports are working properly.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
@RunWith(Parameterized.class)
|
||||
public class DIOCrossConnectTest extends AbstractInterruptTest {
|
||||
|
||||
@@ -17,8 +17,6 @@ import static org.junit.Assert.assertEquals;
|
||||
|
||||
/**
|
||||
* Test for the DigitalGlitchFilter class.
|
||||
*
|
||||
* @author Austin Schuh and Jerry Morrison
|
||||
*/
|
||||
public class DigitalGlitchFilterTest extends AbstractComsSetup {
|
||||
private static final Logger logger = Logger.getLogger(
|
||||
|
||||
@@ -27,8 +27,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Test to see if the FPGA properly recognizes a mock Encoder input.
|
||||
*
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
@RunWith(Parameterized.class)
|
||||
public class EncoderTest extends AbstractComsSetup {
|
||||
|
||||
@@ -22,8 +22,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Test that covers the {@link Compressor}.
|
||||
*
|
||||
* @author Kacper Puczydlowski
|
||||
*/
|
||||
|
||||
public class PCMTest extends AbstractComsSetup {
|
||||
|
||||
@@ -36,9 +36,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Test that covers the {@link PIDController}.
|
||||
*
|
||||
* @author Kacper Puczydlowski
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
|
||||
@RunWith(Parameterized.class)
|
||||
|
||||
@@ -25,8 +25,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Tests the {@link Preferences}.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class PreferencesTest extends AbstractComsSetup {
|
||||
private static final Logger logger = Logger.getLogger(PreferencesTest.class.getName());
|
||||
|
||||
@@ -27,8 +27,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Tests the {@link RelayCrossConnectFixture}.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class RelayCrossConnectTest extends AbstractComsSetup {
|
||||
private static final Logger logger = Logger.getLogger(RelayCrossConnectTest.class.getName());
|
||||
|
||||
@@ -24,8 +24,6 @@ import static org.junit.Assert.assertTrue;
|
||||
* test and use testing fixtures and categories. All tests must extend from {@link
|
||||
* AbstractComsSetup} in order to ensure that Network Communications are set up before the tests are
|
||||
* run.
|
||||
*
|
||||
* @author Fredric Silberberg
|
||||
*/
|
||||
public class SampleTest extends AbstractComsSetup {
|
||||
private static final Logger logger = Logger.getLogger(SampleTest.class.getName());
|
||||
|
||||
@@ -16,8 +16,6 @@ import edu.wpi.first.wpilibj.test.AbstractTestSuite;
|
||||
/**
|
||||
* Holds all of the tests in the root wpilibj directory. Please list alphabetically so that it is
|
||||
* easy to determine if a test is missing from the list.
|
||||
*
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
@RunWith(Suite.class)
|
||||
@SuiteClasses({AnalogCrossConnectTest.class, AnalogPotentiometerTest.class,
|
||||
|
||||
@@ -20,8 +20,6 @@ import edu.wpi.first.wpilibj.test.TestBench;
|
||||
/**
|
||||
* Provides a base implementation for CAN Tests that forces a test of a particular mode to provide
|
||||
* tests of a certain type. This also allows for a standardized base setup for each test.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public abstract class AbstractCANTest extends AbstractComsSetup {
|
||||
public static final double kMotorStopTime = 2;
|
||||
@@ -47,8 +45,6 @@ public abstract class AbstractCANTest extends AbstractComsSetup {
|
||||
/**
|
||||
* Extends the default test watcher in order to provide more information about a tests failure at
|
||||
* runtime.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class CANTestWatcher extends DefaultTestWatcher {
|
||||
@Override
|
||||
|
||||
@@ -20,8 +20,6 @@ import static org.junit.Assert.assertEquals;
|
||||
|
||||
/**
|
||||
* Tests the CAN Motor Controller in Current Quad Encoder mode.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class CANCurrentQuadEncoderModeTest extends AbstractCANTest {
|
||||
private static Logger logger = Logger.getLogger(CANCurrentQuadEncoderModeTest.class.getName());
|
||||
|
||||
@@ -28,8 +28,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* The default test set to run against the CAN Motor Controllers.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class CANDefaultTest extends AbstractCANTest {
|
||||
private static final Logger logger = Logger.getLogger(CANDefaultTest.class.getName());
|
||||
|
||||
@@ -31,8 +31,6 @@ import static org.junit.Assert.assertTrue;
|
||||
|
||||
/**
|
||||
* Tests the CAN motor in PercentQuadEncoderMode.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
@SuppressWarnings("AbbreviationAsWordInName")
|
||||
public class CANPercentQuadEncoderModeTest extends AbstractCANTest {
|
||||
|
||||
@@ -28,8 +28,6 @@ import static org.junit.Assert.assertThat;
|
||||
|
||||
/**
|
||||
* Tests the CAN Motor controller in Potentiometer Mode.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class CANPositionPotentiometerModeTest extends AbstractCANTest {
|
||||
private static final Logger logger = Logger.getLogger(CANPositionPotentiometerModeTest.class
|
||||
|
||||
@@ -21,8 +21,6 @@ import static org.junit.Assert.assertEquals;
|
||||
|
||||
/**
|
||||
* Tests the CAN Motor Encoders in QuadEncoder mode.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class CANPositionQuadEncoderModeTest extends AbstractCANTest {
|
||||
private static final Logger logger = Logger.getLogger(CANPositionQuadEncoderModeTest.class
|
||||
|
||||
@@ -23,8 +23,6 @@ import static org.junit.Assert.assertThat;
|
||||
|
||||
/**
|
||||
* Tests the CAN Speed controllers in quad mode.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class CANSpeedQuadEncoderModeTest extends AbstractCANTest {
|
||||
private static final Logger logger = Logger.getLogger(CANPercentQuadEncoderModeTest.class
|
||||
|
||||
@@ -15,8 +15,6 @@ import edu.wpi.first.wpilibj.test.AbstractTestSuite;
|
||||
|
||||
/**
|
||||
* All of the tests to cover the CAN Motor Controllers.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
@RunWith(Suite.class)
|
||||
@SuiteClasses({CANCurrentQuadEncoderModeTest.class, CANDefaultTest.class,
|
||||
|
||||
@@ -27,8 +27,6 @@ import static org.junit.Assert.assertThat;
|
||||
|
||||
/**
|
||||
* Tests the CAN motor controllers in voltage mode work correctly.
|
||||
*
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
public class CANVoltageQuadEncoderModeTest extends AbstractCANTest {
|
||||
private static final Logger logger = Logger.getLogger(CANVoltageQuadEncoderModeTest.class
|
||||
|
||||
@@ -15,7 +15,6 @@ import edu.wpi.first.wpilibj.test.AbstractTestSuite;
|
||||
|
||||
/**
|
||||
* Contains a listing of all of the {@link Command} tests.
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
@RunWith(Suite.class)
|
||||
@SuiteClasses({ButtonTest.class, CommandParallelGroupTest.class, CommandScheduleTest.class,
|
||||
|
||||
@@ -12,8 +12,6 @@ import edu.wpi.first.wpilibj.AnalogOutput;
|
||||
|
||||
/**
|
||||
* A fixture that connects an {@link AnalogInput} and an {@link AnalogOutput}.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public abstract class AnalogCrossConnectFixture implements ITestFixture {
|
||||
private boolean m_initialized = false;
|
||||
|
||||
@@ -19,8 +19,6 @@ import edu.wpi.first.wpilibj.mockhardware.FakePotentiometerSource;
|
||||
|
||||
/**
|
||||
* A fixture that wraps a {@link CANJaguar}.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public abstract class CANMotorEncoderFixture extends MotorEncoderFixture<CANJaguar> implements
|
||||
ITestFixture {
|
||||
|
||||
@@ -15,8 +15,6 @@ import edu.wpi.first.wpilibj.DigitalOutput;
|
||||
|
||||
/**
|
||||
* Connects a digital input to a digital output.
|
||||
*
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
public class DIOCrossConnectFixture implements ITestFixture {
|
||||
|
||||
|
||||
@@ -15,8 +15,6 @@ import edu.wpi.first.wpilibj.mockhardware.FakeCounterSource;
|
||||
|
||||
/**
|
||||
* A fixture that can test the {@link Counter} using a {@link DIOCrossConnectFixture}.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class FakeCounterFixture implements ITestFixture {
|
||||
private static final Logger logger = Logger.getLogger(FakeEncoderFixture.class.getName());
|
||||
|
||||
@@ -15,8 +15,6 @@ import edu.wpi.first.wpilibj.mockhardware.FakeEncoderSource;
|
||||
/**
|
||||
* An encoder that uses two {@link DIOCrossConnectFixture DIOCrossConnectFixtures} to test the
|
||||
* {@link Encoder}.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class FakeEncoderFixture implements ITestFixture {
|
||||
private static final Logger logger = Logger.getLogger(FakeEncoderFixture.class.getName());
|
||||
|
||||
@@ -16,8 +16,6 @@ import edu.wpi.first.wpilibj.test.TestBench;
|
||||
* obtain references to hardware from the {@link TestBench} class, which is a singleton. Testing
|
||||
* Fixtures are responsible for ensuring that the hardware is in an appropriate state for the start
|
||||
* of a test, and ensuring that future tests will not be affected by the results of a test.
|
||||
*
|
||||
* @author Fredric Silberberg
|
||||
*/
|
||||
public interface ITestFixture {
|
||||
|
||||
|
||||
@@ -24,8 +24,6 @@ import edu.wpi.first.wpilibj.test.TestBench;
|
||||
* reuse. This class should be explicitly instantiated in the TestBed class to allow any test to
|
||||
* access this fixture. This allows tests to be mailable so that you can easily reconfigure the
|
||||
* physical testbed without breaking the tests.
|
||||
*
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
public abstract class MotorEncoderFixture<T extends SpeedController> implements ITestFixture {
|
||||
private static final Logger logger = Logger.getLogger(MotorEncoderFixture.class.getName());
|
||||
|
||||
@@ -12,7 +12,6 @@ import edu.wpi.first.wpilibj.Relay;
|
||||
|
||||
/**
|
||||
* A connection between a {@link Relay} and two {@link DigitalInput DigitalInputs}.
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public abstract class RelayCrossConnectFixture implements ITestFixture {
|
||||
|
||||
|
||||
@@ -11,8 +11,6 @@ package edu.wpi.first.wpilibj.fixtures;
|
||||
/**
|
||||
* This is an example of how to use the {@link ITestFixture} interface to create test fixtures for a
|
||||
* test.
|
||||
*
|
||||
* @author Fredric Silberberg
|
||||
*/
|
||||
public class SampleFixture implements ITestFixture {
|
||||
|
||||
|
||||
@@ -16,8 +16,6 @@ import edu.wpi.first.wpilibj.Timer;
|
||||
/**
|
||||
* A class to represent the a physical Camera with two servos (tilt and pan) designed to test to see
|
||||
* if the gyroscope is operating normally.
|
||||
*
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
public abstract class TiltPanCameraFixture implements ITestFixture {
|
||||
public static final Logger logger = Logger.getLogger(TiltPanCameraFixture.class.getName());
|
||||
|
||||
@@ -12,8 +12,6 @@ import edu.wpi.first.wpilibj.Timer;
|
||||
|
||||
/**
|
||||
* Simulates an encoder for testing purposes.
|
||||
*
|
||||
* @author Ryan O'Meara
|
||||
*/
|
||||
public class FakeCounterSource {
|
||||
|
||||
|
||||
@@ -12,8 +12,6 @@ import edu.wpi.first.wpilibj.Timer;
|
||||
|
||||
/**
|
||||
* Emulates a quadrature encoder.
|
||||
*
|
||||
* @author Ryan O'Meara
|
||||
*/
|
||||
public class FakeEncoderSource {
|
||||
|
||||
|
||||
@@ -11,8 +11,6 @@ import edu.wpi.first.wpilibj.AnalogOutput;
|
||||
|
||||
/**
|
||||
* A fake source to provide output to a {@link edu.wpi.first.wpilibj.interfaces.Potentiometer}.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class FakePotentiometerSource {
|
||||
private AnalogOutput m_output;
|
||||
|
||||
@@ -20,8 +20,6 @@ import static org.junit.Assert.assertEquals;
|
||||
|
||||
/**
|
||||
* Test that covers {@link SmartDashboard}.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class SmartDashboardTest extends AbstractComsSetup {
|
||||
private static final Logger logger = Logger.getLogger(SmartDashboardTest.class.getName());
|
||||
|
||||
@@ -15,8 +15,6 @@ import edu.wpi.first.wpilibj.test.AbstractTestSuite;
|
||||
|
||||
/**
|
||||
* All tests pertaining to {@link SmartDashboard}.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
@RunWith(Suite.class)
|
||||
@SuiteClasses({SmartDashboardTest.class})
|
||||
|
||||
@@ -27,9 +27,6 @@ import edu.wpi.first.wpilibj.livewindow.LiveWindow;
|
||||
* an {@link BeforeClass} statement to initialize network communications. Any test that needs to use
|
||||
* the hardware <b>MUST</b> extend from this class, to ensure that all of the hardware will be able
|
||||
* to run.
|
||||
*
|
||||
* @author Fredric Silberberg
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
public abstract class AbstractComsSetup {
|
||||
/**
|
||||
@@ -185,8 +182,6 @@ public abstract class AbstractComsSetup {
|
||||
/**
|
||||
* Provided as a replacement to lambda functions to allow for repeatable checks to see if a
|
||||
* correct state is reached.
|
||||
*
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
public abstract class BooleanCheck {
|
||||
public BooleanCheck() {
|
||||
|
||||
@@ -22,8 +22,6 @@ import java.util.regex.Pattern;
|
||||
/**
|
||||
* Allows tests suites and tests to be run selectively from the command line using a regex text
|
||||
* pattern.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public abstract class AbstractTestSuite {
|
||||
private static final Logger logger = Logger.getLogger(AbstractTestSuite.class.getName());
|
||||
@@ -63,8 +61,6 @@ public abstract class AbstractTestSuite {
|
||||
/**
|
||||
* Stores a method name and method class pair. Used when searching for methods matching a given
|
||||
* regex text.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
protected class ClassMethodPair {
|
||||
public final Class<?> m_methodClass;
|
||||
|
||||
@@ -27,8 +27,6 @@ import static org.junit.Assert.assertEquals;
|
||||
/**
|
||||
* Yes, this is the test system testing itself. Functionally, this is making sure that all tests get
|
||||
* run correctly when you use parametrized arguments.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class AbstractTestSuiteTest {
|
||||
|
||||
|
||||
@@ -19,8 +19,6 @@ import java.io.File;
|
||||
/**
|
||||
* Provides an entry point for tests to run with ANT. This allows ant to output JUnit XML test
|
||||
* results for Jenkins.
|
||||
*
|
||||
* @author jonathanleitschuh
|
||||
*/
|
||||
public class AntJunitLanucher {
|
||||
|
||||
|
||||
@@ -16,8 +16,6 @@ import java.util.logging.Logger;
|
||||
* framework. This test is NOT run as a normal part of the testing process and must be explicitly
|
||||
* selected at runtime by using the 'quick' argument. This test should never be committed with
|
||||
* changes to it but can be used during development to aid in feature testing.
|
||||
*
|
||||
* @author Jonathan Leitschuh
|
||||
*/
|
||||
public class QuickTest extends AbstractComsSetup {
|
||||
private static final Logger logger = Logger.getLogger(QuickTest.class.getName());
|
||||
|
||||
@@ -23,8 +23,6 @@ import java.lang.annotation.Target;
|
||||
* <p>This code was originally found here:
|
||||
* <a href="http://www.codeaffine.com/2013/04/10/running-junit-tests-repeatedly-without-loops/">
|
||||
* Running JUnit Tests Repeatedly Without Loops</a>
|
||||
*
|
||||
* @author Frank Appel
|
||||
*/
|
||||
public class RepeatRule implements TestRule {
|
||||
@Retention(RetentionPolicy.RUNTIME)
|
||||
|
||||
@@ -40,10 +40,6 @@ import edu.wpi.first.wpilibj.mockhardware.FakePotentiometerSource;
|
||||
* This class provides access to all of the elements on the test bench, for use in fixtures. This
|
||||
* class is a singleton, you should use {@link #getInstance()} to obtain a reference to the {@code
|
||||
* TestBench}.
|
||||
*
|
||||
* <p>TODO: This needs to be updated to the most recent test bench setup.
|
||||
*
|
||||
* @author Fredric Silberberg
|
||||
*/
|
||||
public final class TestBench {
|
||||
|
||||
|
||||
Reference in New Issue
Block a user