Simplify comments

Author: tchoi-rs

src/test/java/com/axiope/webapp/dev/ViteDevServerProxyServletMimeTypeTest.java

@@ -5,10 +5,7 @@
 
 import org.junit.jupiter.api.Test;
 
-/**
- * inferFallbackContentType is a pure function of the request path, so it lives here rather than
- * alongside the proxying tests, where it would inherit an unrelated HTTP-exchange fixture.
- */
+/** Separate from the proxying tests: inferFallbackContentType needs no mocks. */
 public class ViteDevServerProxyServletMimeTypeTest {
 
   private final ViteDevServerProxyServlet servlet =

src/test/java/com/researchspace/files/service/ExternalFileServiceTest.java

@@ -59,9 +59,7 @@ public void before() throws Exception {
             anyUser, "anyToken - this is a mock API call");
   }
 
-  // Was annotated @Before (now @BeforeEach) despite being named after() and documented as tidy-up,
-  // so it has never run as teardown. A no-op today because the setFileStore(localFs) call it pairs
-  // with is commented out in before(); kept and corrected so restoring that line stays safe.
+  // A no-op while the setFileStore(localFs) call it pairs with stays commented out in before().
   @AfterEach
   public void restoreFileStore() throws Exception {
     getTargetObject(mediaMgr, MediaManagerImpl.class).setFileStore(fileStore);

src/test/java/com/researchspace/service/impl/ZipCopyTest.java

@@ -19,9 +19,6 @@ public class ZipCopyTest {
   // https://stackoverflow.com/questions/50594360/gzipinputstream-works-with-fileinputstream-but-not-inputstream/50610474#50610474
   @Test
   public void classPathAndFileReadsAreTheSameBytes() throws IOException {
-    // readAllBytes rather than a fixed-size buffer: a buffer larger than the zip zero-pads both
-    // sides equally and a buffer smaller than it compares only a prefix, so either way a
-    // difference in the tail passes unnoticed once the file outgrows the number.
     try (InputStream fromClasspath = fromClasspath()) {
       assertArrayEquals(
           fromClasspath.readAllBytes(),

src/test/java/com/researchspace/slack/SlackPosterTest.java

@@ -19,8 +19,6 @@
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.client.RestTemplate;
 
-// @Disabled rather than gated on -Dnightly like the other real-connection tests: this one needs a
-// secret webhook URL that no environment supplies, so a nightly gate would never fire either.
 @Disabled("requires correct real secret webhook")
 public class SlackPosterTest extends SpringTransactionalTest {
 

src/test/java/com/researchspace/testutils/DatabaseCleaner.java

@@ -22,10 +22,8 @@ public void setDataSource(DataSource dataSource) {
   /** Manually deletes records and folders from tables. */
   public static void cleanUp() {
     if (jdbcTemplate == null) {
-      // Nothing was ever injected, so no context loaded in this fork and there is nothing to clean.
-      // Callers already skip this on a fast run; this covers the other way @AfterAll can be reached
-      // without a context, namely a context *load failure*, which Jupiter follows with @AfterAll
-      // where JUnit 4 skipped @AfterClass. Without this, that NPEs here and hides the Spring error.
+      // No context loaded, so nothing to clean. Jupiter runs @AfterAll even when the context failed
+      // to load, and without this that NPEs here and hides the underlying Spring error.
       return;
     }
     // delete from Batch tables

src/test/java/com/researchspace/testutils/WithSpringContext.java

@@ -9,20 +9,13 @@
 import org.springframework.test.context.junit.jupiter.SpringExtension;
 
 /**
- * Wires a test class into the Spring TestContext framework.
- *
- * <p>This is the composed-annotation equivalent of extending a Spring base class. JUnit 4 needed a
- * base class because a runner is class-level and cannot be composed, which is why Spring shipped
- * {@code AbstractJUnit4SpringContextTests}; Jupiter registers the equivalent behaviour through an
- * extension instead, so the single superclass a test gets to spend stays free.
- *
- * <p>Deliberately adds nothing but the extension. In particular it declares no
- * {@code @TestExecutionListeners}: naming any set here would replace Spring's defaults for every
- * annotated class that does not declare its own, silently dropping listeners such as {@code
- * ServletTestExecutionListener} and {@code TransactionalTestExecutionListener}.
- *
- * <p>Combine it with a context annotation such as {@link DefaultTestContext}, or with
+ * Wires a test class into the Spring TestContext framework, leaving its single superclass free.
+ * Combine with a context annotation such as {@link DefaultTestContext}, or
  * {@code @ContextConfiguration} directly.
+ *
+ * <p>Do not add {@code @TestExecutionListeners} here: naming any set replaces Spring's defaults for
+ * every annotated class that does not declare its own, silently dropping listeners such as {@code
+ * TransactionalTestExecutionListener}.
  */
 @ExtendWith(SpringExtension.class)
 @Retention(RetentionPolicy.RUNTIME)

src/test/java/com/researchspace/webapp/controller/ScheduledMaintenanceControllerMVCIT.java

@@ -78,10 +78,9 @@ private void initMaintenanceTestUsers() {
 
   private void initDates() {
     if (dateNextHour == null) {
-      // The trailing -00:00 in the pattern is a literal, and the server parses these strings as
-      // UTC. Formatting must therefore happen in UTC too, otherwise local wall-clock time is
-      // labelled as UTC and every relative date is shifted by the machine's offset: in a
-      // negative-offset zone the "future" maintenance dates below land in the past.
+      // The -00:00 in the pattern is a literal and the server parses these as UTC, so format in
+      // UTC too or local wall-clock time gets labelled UTC and every date below shifts by the
+      // machine's offset.
       dateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.000-00:00");
       dateFormat.setTimeZone(TimeZone.getTimeZone(ZoneOffset.UTC));
 
@@ -189,11 +188,8 @@ public void testCreateUpdateDeleteScheduledMaintenance() throws Exception {
   @Test
   public void testActiveMaintenanceCreateRetrieveFinishNow() throws Exception {
     String testMessage = "test maintenance message";
-    // The start date is posted as an absolute instant but the server renders it back in the user's
-    // timezone (SessionTimeZoneUtils, which falls back to the JVM default when the session carries
-    // no preference, as it does here), so the expected strings have to be derived rather than
-    // hard-coded or the test only passes under UTC. Everything below comes from this one instant:
-    // a second literal for the posted form of it would silently drift out of sync with it.
+    // Rendered back in the session's timezone, which falls back to the JVM default here, so the
+    // expected strings are derived from this one instant rather than hard-coded under UTC.
     Instant start = Instant.parse("2015-01-01T00:00:01Z");
     String oldDateString = dateFormat.format(Date.from(start));
     DateTimeFormatter clientFormat =

src/test/java/com/researchspace/webapp/controller/WorkspaceControllerTest.java

@@ -143,8 +143,7 @@ public void setUp() throws Exception {
   }
 
   private void clearUsersCustomFormsAddedToMenu() {
-    // Map<?, ?> rather than Map<Long, Boolean>: clear() takes no type parameter, so the wildcard
-    // cast is one the compiler can check, leaving no unchecked warning to suppress.
+    // Map<?, ?> keeps the cast checkable; clear() needs no type parameter.
     ((Map<?, ?>)
             ReflectionTestUtils.getField(
                 WorkspaceController.class, "USERS_CUSTOM_FORMS_ADDED_TO_MENU"))
@@ -364,8 +363,6 @@ private Long getAValidRecordId() throws Exception {
     workspaceController.listRootFolder(
         "", model, mockPrincipal, request, session, response, new WorkspaceSettings());
     assertTrue((Boolean) model.getAttribute("publish_allowed"));
-    // Wildcard plus an explicit element cast: both are checkable, so neither needs suppressing.
-    // Erasure put the same checkcast on Record at the getId() call before, so this is equivalent.
     ISearchResults<?> res = (ISearchResults<?>) model.asMap().get("searchResults");
     Long recordId = ((Record) res.getResults().get(0)).getId();
     tss.clear();