[master] Fix providing error message for openapi spec generation when bal service has compilation issues #1370

lnash94 · 2023-05-26T08:55:59Z

Purpose

ballerina-platform/ballerina-library#5134

Automation tests

Unit tests - added

Code coverage information
Integration tests

Details about the test cases and coverage

Security checks

Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? yes/no
Ran FindSecurityBugs plugin and verified report? yes/no
Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? yes/no

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

…ompilation issue

lnash94 · 2023-06-22T04:17:21Z

Hold due to priorities some urgent fixes

…i-tools into compilation_error_1364 # Conflicts: # gradle.properties

...ion-tests/src/test/resources/ballerina_sources/bal_service_has_compilation_issue/service.bal

openapi-build-extension/src/main/java/io/ballerina/openapi/build/HttpServiceAnalysisTask.java

openapi-cli/src/main/java/io/ballerina/openapi/cmd/OASContractGenerator.java

dilanSachi · 2024-01-30T04:29:09Z

openapi-cli/src/main/java/io/ballerina/openapi/cmd/OASContractGenerator.java

+            // if there are any compilation errors, do not proceed and those diagnostic will display to user
+            outStream.println("OpenAPI contract generation failed due to Ballerina code has compilation errors. :");
+            compilation.diagnosticResult().diagnostics().forEach(diagnostic -> {
+                if (diagnostic.diagnosticInfo().severity().equals(DiagnosticSeverity.ERROR)) {


i remember there was an api for this like diagnostic.diagnosticInfo().hasErrors() or something like that

openapi-integration-tests/src/test/java/io/ballerina/openapi/cmd/BallerinaToOpenAPITests.java

dilanSachi · 2024-01-30T04:34:31Z

...on-tests/src/test/java/io/ballerina/openapi/extension/build/BuildExtensionNegativeTests.java

+        Thread.sleep(5000);
+        // compare generated file has not included constraint annotation for scenario record field.
+        Assert.assertFalse(Files.exists(RESOURCE.resolve("\"build/package_with_compilation_issue/target/openapi/")));
+        process.waitFor();


If we do waitFor before the assert, do we need the above sleep?

openapi-build-extension/src/main/java/io/ballerina/openapi/build/HttpServiceAnalysisTask.java

openapi-cli/src/main/java/io/ballerina/openapi/cmd/OASContractGenerator.java

github-actions · 2024-03-02T19:34:49Z

This PR has been open for more than 15 days with no activity. This will be closed in 3 days unless the stale label is removed or commented.

sonarqubecloud · 2024-03-07T11:33:45Z

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

github-actions · 2024-03-22T19:34:45Z

This PR has been open for more than 15 days with no activity. This will be closed in 3 days unless the stale label is removed or commented.

NipunaRanasinghe · 2024-03-25T08:21:21Z

openapi-cli/src/test/java/io/ballerina/openapi/generators/openapi/HttpMethodTests.java


 /**
 * This test class is for capturing special tests regarding resource methods.
 */
 public class HttpMethodTests {
    private static final Path RES_DIR = Paths.get("src/test/resources/ballerina-to-openapi/").toAbsolutePath();
    private Path tempDir;
-    private final ByteArrayOutputStream outputStreamCaptor = new ByteArrayOutputStream();
+    private final PrintStream standardOut = System.out;


Suggested change

private final PrintStream standardOut = System.out;

private final PrintStream stdOut = System.out;

NipunaRanasinghe · 2024-03-25T08:22:49Z

...gration-tests/src/test/java/io/ballerina/openapi/cmd/BallerinaToOpenAPICLINegativeTests.java

+import static io.ballerina.openapi.TestUtil.assertOnErrorStream;
+
+/**
+ * This {@code BallerinaToOpenAPITests} contains all the ballerina to openapi command negative.


Wrong link

Suggested change

* This {@code BallerinaToOpenAPITests} contains all the ballerina to openapi command negative.

* This class contains all the ballerina to OpenAPI command related negative tests.

NipunaRanasinghe · 2024-03-25T08:25:17Z

openapi-build-extension/src/main/java/io/ballerina/openapi/build/HttpServiceAnalysisTask.java

+            outStream.println("openapi contract generation is skipped because the compilation error(s)" +
+                    " in the ballerina package");


Suggested change

outStream.println("openapi contract generation is skipped because the compilation error(s)" +

" in the ballerina package");

outStream.println("openapi contract generation is skipped because of the compilation error(s)" +

" in the ballerina package");

NipunaRanasinghe · 2024-03-25T08:27:12Z

openapi-build-extension/src/main/java/io/ballerina/openapi/build/HttpServiceAnalysisTask.java

@@ -68,6 +69,11 @@
 * @since 2.0.0
 */
 public class HttpServiceAnalysisTask implements AnalysisTask<SyntaxNodeAnalysisContext> {
+    static boolean isErrorPrinted = false;


Whats the purpose of having this flag? can the analysis get triggered multiple times during a single compilation?

lnash94 · 2024-04-02T03:19:00Z

This PR is on hold for a while, till the other priority tasks complete

github-actions · 2024-04-17T19:34:19Z

This PR has been open for more than 15 days with no activity. This will be closed in 3 days unless the stale label is removed or commented.

lnash94 · 2024-04-20T11:37:46Z

#1692

lnash94 added 2 commits May 24, 2023 11:32

Fix diagnostic display for compilation error

5eb744e

Add error message for openapi spec generations when bal service has c…

3ba1000

…ompilation issue

lnash94 force-pushed the compilation_error_1364 branch from 12dffbc to 3ba1000 Compare May 27, 2023 03:23

Fix tests

018a6f7

github-actions bot added the Stale label Jun 11, 2023

lnash94 removed the Stale label Jun 12, 2023

github-actions bot added the Stale label Jul 7, 2023

lnash94 removed the Stale label Jul 10, 2023

lnash94 added 2 commits July 12, 2023 12:16

Merge branch 'master' of https://github.com/ballerina-platform/openap…

292ea69

…i-tools into compilation_error_1364 # Conflicts: # gradle.properties

Fix tests

2de04d4

github-actions bot added the Stale label Aug 4, 2023

lnash94 removed the Stale label Aug 7, 2023

github-actions bot added the Stale label Aug 22, 2023

lnash94 removed the Stale label Aug 23, 2023

github-actions bot added the Stale label Sep 7, 2023

github-actions bot closed this Sep 11, 2023

lnash94 reopened this Sep 12, 2023

github-actions bot closed this Sep 15, 2023

lnash94 removed the Stale label Sep 20, 2023

lnash94 reopened this Oct 2, 2023

ballerina-platform deleted a comment from github-actions bot Oct 2, 2023

github-actions bot added the Stale label Oct 17, 2023

github-actions bot closed this Oct 21, 2023

lnash94 reopened this Nov 1, 2023

SachinAkash01 reviewed Jan 30, 2024

View reviewed changes

...ion-tests/src/test/resources/ballerina_sources/bal_service_has_compilation_issue/service.bal Show resolved Hide resolved

...ion-tests/src/test/resources/ballerina_sources/bal_service_has_compilation_issue/service.bal Show resolved Hide resolved

dilanSachi reviewed Jan 30, 2024

View reviewed changes

openapi-build-extension/src/main/java/io/ballerina/openapi/build/HttpServiceAnalysisTask.java Outdated Show resolved Hide resolved

dilanSachi reviewed Jan 30, 2024

View reviewed changes

openapi-cli/src/main/java/io/ballerina/openapi/cmd/OASContractGenerator.java Outdated Show resolved Hide resolved

dilanSachi reviewed Jan 30, 2024

View reviewed changes

openapi-integration-tests/src/test/java/io/ballerina/openapi/cmd/BallerinaToOpenAPITests.java Outdated Show resolved Hide resolved

dilanSachi reviewed Jan 30, 2024

View reviewed changes

TharmiganK reviewed Jan 30, 2024

View reviewed changes

github-actions bot added the Stale label Feb 15, 2024

TharmiganK removed the Stale label Feb 16, 2024

ballerina-platform deleted a comment from github-actions bot Feb 16, 2024

github-actions bot added the Stale label Mar 2, 2024

lnash94 removed the Stale label Mar 4, 2024

lnash94 and others added 3 commits March 7, 2024 15:11

Fix review suggestions

c66d738

Fix review suggestions

5c6e885

Merge branch 'master' into compilation_error_1364

bbfa308

lnash94 force-pushed the compilation_error_1364 branch from 4709e89 to bbfa308 Compare March 7, 2024 11:32

github-actions bot added the Stale label Mar 22, 2024

NipunaRanasinghe reviewed Mar 25, 2024

View reviewed changes

lnash94 removed the Stale label Mar 25, 2024

github-actions bot added the Stale label Apr 17, 2024

lnash94 removed the Stale label Apr 19, 2024

lnash94 mentioned this pull request Apr 20, 2024

[master] Fix providing error message for openapi spec generation when bal service has compilation issues #1692

Merged

lnash94 closed this Apr 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[master] Fix providing error message for openapi spec generation when bal service has compilation issues #1370

[master] Fix providing error message for openapi spec generation when bal service has compilation issues #1370

lnash94 commented May 26, 2023 •

edited

Loading

lnash94 commented Jun 22, 2023

dilanSachi Jan 30, 2024

dilanSachi Jan 30, 2024

github-actions bot commented Mar 2, 2024

sonarqubecloud bot commented Mar 7, 2024

github-actions bot commented Mar 22, 2024

NipunaRanasinghe Mar 25, 2024

NipunaRanasinghe Mar 25, 2024

NipunaRanasinghe Mar 25, 2024

NipunaRanasinghe Mar 25, 2024

lnash94 commented Apr 2, 2024

github-actions bot commented Apr 17, 2024

lnash94 commented Apr 20, 2024

	private final PrintStream standardOut = System.out;
	private final PrintStream stdOut = System.out;

	* This {@code BallerinaToOpenAPITests} contains all the ballerina to openapi command negative.
	* This class contains all the ballerina to OpenAPI command related negative tests.

		outStream.println("openapi contract generation is skipped because the compilation error(s)" +
		" in the ballerina package");

[master] Fix providing error message for openapi spec generation when bal service has compilation issues #1370

[master] Fix providing error message for openapi spec generation when bal service has compilation issues #1370

Conversation

lnash94 commented May 26, 2023 • edited Loading

Purpose

Automation tests

Security checks

Samples

Related PRs

Migrations (if applicable)

Test environment

Learning

lnash94 commented Jun 22, 2023

dilanSachi Jan 30, 2024

Choose a reason for hiding this comment

dilanSachi Jan 30, 2024

Choose a reason for hiding this comment

github-actions bot commented Mar 2, 2024

sonarqubecloud bot commented Mar 7, 2024

Quality Gate passed

github-actions bot commented Mar 22, 2024

NipunaRanasinghe Mar 25, 2024

Choose a reason for hiding this comment

NipunaRanasinghe Mar 25, 2024

Choose a reason for hiding this comment

NipunaRanasinghe Mar 25, 2024

Choose a reason for hiding this comment

NipunaRanasinghe Mar 25, 2024

Choose a reason for hiding this comment

lnash94 commented Apr 2, 2024

github-actions bot commented Apr 17, 2024

lnash94 commented Apr 20, 2024

lnash94 commented May 26, 2023 •

edited

Loading