OpenAPITools / OpenAPITools/openapi-generator

[BUG] [Spring] Generated test classes are marked as sources instead of test

Open
#13,677 13 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • [N/A] Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

When generating interfaces (invoker) for spring generator the generated test resources are marked as Sources instead of Test Sources.
This will break the compilation if test resources are marked as test scope.
Also see my response on this question: https://stackoverflow.com/questions/73450027/java-maven-openapi-3-0-codegen-is-generating-unwanted-test-file-how-to-remove

Workaround: run with <interfaceOnly>true</interfaceOnly> (avoid test generation).

openapi-generator version

6.2.0, 6.0.1

OpenAPI declaration file content or url

N/A - anything is sufficient

openapi: 3.0.3
info:
  title: test
  version: "1.0"
servers:
  - url: http://localhost:8080/
    description: Local
tags:
  - name: Target
    description: Targets related REST endpoints.
paths:
  /target:
    get:
      tags:
        - Target
      summary: Retrieves all targets
      description: Returns all targets
      operationId: getTargets
      responses:
        '200':
          description: successful operation
                    <plugin>
				<groupId>org.openapitools</groupId>
				<artifactId>openapi-generator-maven-plugin</artifactId>
				<version>${openapi-generator.version}</version>
				<executions>
					<execution>
						<goals>
							<goal>generate</goal>
						</goals>
						<id>generate-files-from-openapi</id>
						<configuration>
							<inputSpec>${project.basedir}/src/main/resources/static/api.yaml</inputSpec>
							<generatorName>spring</generatorName>
							<library>spring-boot</library>
							<configOptions>
<!--								<interfaceOnly>true</interfaceOnly>-->
							</configOptions>
						</configuration>
					</execution>
				</executions>
			</plugin>
Generation Details

spring

Steps to reproduce

Generate sources and check project strcture.

Related issues/PRs
Suggest a fix

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue with the supplied OpenAPI YAML and Maven plugin configuration using the Spring generator, then inspect how generated test resources are classified in the project structure. Done means those resources are marked as test sources rather than sources and the project compiles when test resources use test scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
build-system, testing
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.