groovy

<!--
  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing,
  software distributed under the License is distributed on an
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, either express or implied.  See the License for the
  specific language governing permissions and limitations
  under the License.
-->

See [`../AGENTS.md`](../AGENTS.md) for project-specific guidance for AI
coding assistants contributing to Apache Groovy, including ASF licensing
and provenance requirements.

## Reviewing tests (inline Javadoc tests)

Groovy tests many methods inline: a `<pre class="...groovyTestCase">`
block inside a Javadoc/GroovyDoc comment is **extracted and executed as
a real JUnit test** by `groovy.test.JavadocAssertionTestSuite`
(`src/test/groovy/MainJavadocAssertionTest.groovy` for `src/main`;
subprojects have their own `*JavadocAssertionTest`). This is the
standard test form for the GDK (`DefaultGroovyMethods`,
`ArrayGroovyMethods`, and similar) — the worked `assert` examples in a
method's Javadoc *are* its test suite.

Therefore, when a change adds or contains `groovyTestCase` Javadoc
blocks covering the new behaviour, **do not flag it as "missing tests"
or "no accompanying unit tests"** — the tests are present and run in
CI. Only flag genuinely untested behaviour (no `groovyTestCase` block
and nothing else exercising it). Canonical detail: see "Inline Javadoc
tests" in [`../CONTRIBUTING.md`](../CONTRIBUTING.md).

## Reviewing tests (spec tests)

Tests under `src/spec/test/` (and `subprojects/<module>/src/spec/test/`)
are executable examples `include::`'d into the user-facing AsciiDoc
docs; they run as real tests. They are deliberately curated to read as
documentation — clear, representative examples, usually the happy path.
Error cases, edge cases, extra coverage, and regression tests for
tracked bugs typically live in the ordinary `src/test/` tree instead.

Therefore: a spec test **is** that behaviour's coverage. Do not flag a
spec example as "untested", and **do not request that spec coverage be
duplicated** in `src/test/`. Only ask for additional `src/test/`
coverage for behaviour (error/edge cases) genuinely not exercised
anywhere. Canonical detail: see "Executable AsciiDoc examples" in
[`../CONTRIBUTING.md`](../CONTRIBUTING.md).

More agent context in apache/groovy

11 other files this repository gives its agents.