Changes between Version 24 and Version 25 of GoodCodeExamples

Timestamp:

05/20/09 17:05:08 (16 years ago)

Author:

meddle

Comment:

--

GoodCodeExamples

@@ -100 +100 @@
                                 res.setDefaultCloseOperation(closeOperation);
 }}}
+ * Writing tests:
+  * Write tests that test something you wrote, not the JDK
+  * The tests are code, so all the above rules apply to them.
+  * You can use the template for tests in Eclipse, write the word test -> ctrl+space -> choose the "test - test method" template from the auto-complete menu.
+  * Our tests extend either UnitTestBase, either IntegrationTestBase.
+  * Put @After, @Before and @Test annotations.
+  * The first thing in a setUp method is calling the super.setUp() method, the last thing in a tearDown method is calling the super.tearDown() method.
+  * Example for good test:
+{{{
+package org.sophie2.base.commons.util.position;
+
+
+
+import junit.framework.AssertionFailedError;
+
+
+
+import org.junit.After;
+
+import org.junit.Before;
+
+import org.junit.Test;
+
+import org.sophie2.core.testing.UnitTestBase;
+
+
+
+/**
+
+ * Unit test for {@link ImmVector}.
+
+ * 
+
+ * @author Pap
+
+ */
+
+public class ImmVectorTest extends UnitTestBase {
+
+
+
+        @Override
+
+        @Before
+
+        protected void setUp() throws Exception {
+
+                super.setUp();
+
+        }
+
+
+
+        @Override
+
+        @After
+
+        protected void tearDown() throws Exception {
+
+                super.tearDown();
+
+        }
+
+
+
+        /**
+
+         * Tests getters of {@link ImmVector}.
+
+         */
+
+        @Test
+
+        public void testGetters() {
+
+                float x = 5.0f;
+
+                float y = 10.0f;
+
+                float t = 2.0f;
+
+
+
+                ImmVector v = new ImmVector(x, y, t);
+
+
+
+                assertEquals(x, v.getX());
+
+                assertEquals(y, v.getY());
+
+                assertEquals(t, v.getT());
+
+                assertEquals(x / t, v.getPointX());
+
+                assertEquals(y / t, v.getPointY());
+
+        }
+
+
+
+        /**
+
+         * Tests {@link ImmVector#add(ImmVector)}.
+
+         */
+
+        @Test
+
+        public void testAdd() {
+
+                ImmVector vec1 = new ImmVector(10.0f, 10.0f);
+
+                ImmVector vec2 = new ImmVector(5.0f, 20.0f);
+
+
+
+                ImmVector expected = new ImmVector(15.0f, 30.0f);
+
+                assertEquals(expected, vec1.add(vec2));
+
+
+
+        }
+
+
+
+        /**
+
+         * Tests {@link ImmVector#dotProduct(ImmVector)}.
+
+         */
+
+        @Test
+
+        public void testDotProduct() {
+
+                ImmVector vec1 = new ImmVector(1.0f, 1.0f, 0);
+
+                ImmVector vec2 = new ImmVector(-1.0f, 1.0f, 0);
+
+
+
+                float res = vec1.dotProduct(vec2);
+
+                float expected = 0f;
+
+
+
+                assertEquals(expected, res);
+
+        }
+
+
+
+        /**
+
+         * Tests whether {@link ImmRect} is immutable.
+
+         */
+
+        @Test
+
+        public void testImmutable() {
+
+                ImmVector v1 = new ImmVector(10.0f, 5.0f, 2.0f);
+
+                ImmVector v2 = v1;
+
+
+
+                assertSame(v1, v2);
+
+
+
+                ImmVector result = v1.add(new ImmVector(0, 0, 1));
+
+                assertNotSame(v1, result);
+
+                assertTrue(v1.equalsHomogeneously(result));
+
+                assertSame(v1, v1);
+
+        }
+
+
+
+        /**
+
+         * Tests {@link ImmVector#equalsHomogeneously}.
+
+         */
+
+        @Test
+
+        public void testEqualsHomogeneouslyVectors() {
+
+                ImmVector v1 = new ImmVector(10, 10, 0);
+
+                ImmVector v2 = new ImmVector(20, 20, 0);
+
+
+
+                assertTrue(v1.equalsHomogeneously(v2));
+
+
+
+                ImmVector v3 = new ImmVector(10, 15, 0);
+
+                assertFalse(v1.equalsHomogeneously(v3));
+
+
+
+                ImmVector v4 = new ImmVector(10, 10, 1);
+
+                ImmVector v5 = new ImmVector(20, 20, 2);
+
+
+
+                assertTrue(v4.equalsHomogeneously(v5));
+
+
+
+                ImmVector v6 = new ImmVector(10, 10, 2);
+
+                assertFalse(v6.equalsHomogeneously(v4));
+
+        }
+
+
+
+        /**
+
+         * Tests {@link ImmVector#opposite()}.
+
+         */
+
+        @Test
+
+        public void testOpposite() {
+
+                ImmVector vec = new ImmVector(10.0f, 10.0f);
+
+                ImmVector res = vec.opposite();
+
+                ImmVector expected = new ImmVector(-10.0f, -10.0f);
+
+
+
+                assertEquals(expected, res);
+
+        }
+
+
+
+        /**
+
+         * Tests that multiplication between a {@link ImmVector} and a
+
+         * {@link ImmPoint} is undefined.
+
+         */
+
+        @Test
+
+        public void testDotProductVectorPoint() {
+
+                ImmVector point = new ImmVector(1.0f, 1.0f, 1.0f);
+
+                ImmVector vector = new ImmVector(1, 1, 0);
+
+
+
+                try {
+
+                        point.dotProduct(vector);
+
+                        fail();
+
+                } catch (Throwable t) {
+
+                        if (t instanceof AssertionFailedError) {
+
+                                fail();
+
+                        }
+
+                }
+
+        }
+
+
+
+        /**
+
+         * Tests that a vector must not have all zero coordinates.
+
+         */
+
+        @Test
+
+        public void testEqualsPointVector() {
+
+
+
+                ImmVector point = new ImmVector(1, 1, 1);
+
+                ImmVector vector = new ImmVector(1, 1, 0);
+
+
+
+                assertFalse(point.equals(vector));
+
+        }
+
+
+
+        /**
+
+         * Tests that a {@link ImmVector} cannot have all coordinates equal to zero.
+
+         */
+
+        @Test
+
+        public void testAllZeroes() {
+
+                try {
+
+                        new ImmVector(0, 0, 0);
+
+                        fail();
+
+                } catch (Throwable t) {
+
+                        if (t instanceof AssertionFailedError) {
+
+                                fail();
+
+                        }
+
+                }
+
+        }
+
+}
+
+
+}}}