Implemented missing definitions of declared methods inside modelbase-header.mustache, added two missing body of methods definitions #19569

SaverioCode · 2024-09-11T13:07:50Z

Fix #19566 implemented missing definitions of declared methods inside modelbase-header.mustache for the cpp-rest-sdk-client
I have also added two missing body of methods definitions

PR checklist

Read the contribution guidelines.
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
Run the following to build the project and update samples:
```
./mvnw clean package 
./bin/generate-samples.sh ./bin/configs/*.yaml
./bin/utils/export_docs_generators.sh
```
(For Windows users, please run the script in Git BASH)
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
File the PR against the correct branch: master (upcoming 7.6.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@ravinikam @stkrwork @etherealjoy @MartinDelille @muttleyxd

… methods inside openapi-generator/modules/openapi-generator/src/main/resources/cpp-rest-sdk-client/modelbase-header.mustache, have also be added two missing body of methods definitions

muttleyxd

Looks good, but it'd be good to fix shared_ptr creation

modules/openapi-generator/src/main/resources/cpp-rest-sdk-client/modelbase-header.mustache

muttleyxd · 2024-09-12T05:38:04Z

Looks good now!

wing328 · 2024-09-12T08:05:49Z

modules/openapi-generator/src/main/resources/cpp-rest-sdk-client/modelbase-header.mustache

-    if( val != nullptr )
-    {
-        val->toJson().serialize(ss);
-    }


@SaverioCode thanks for the PR

quick question if you don't mind. why remove the null check here and below (line 208)?

@SaverioCode thanks for the PR

quick question if you don't mind. why remove the null check here and below (line 208)?

Hi!

I removed them in several places because they are reference and in c++ they can't be nullptr for definition. There is a compile error if a reference is nullptr. A reference is an alias to an already-existing object or function. So in this scenario the shared_ptr can't be nullptr, what could actually be invalid is the pointer inside the shared_ptr, the content of the referred object, but not the object itself
As it's done for any object that contains pointers, I suppose it would make sense to check the content of the shared_ptr (it's not what was happening), but being a shared_ptr I would assume that the pointer inside it's valid or I would think more of a program logic error. But this last consideration can be different from team to team

thanks for the explanation

cc @etherealjoy who added the nullptr check to see if he's further comment/question on this

wing328 · 2024-09-16T09:34:46Z

thanks again for the PR

seems like I couldn't repeat the issue. I got the following (tests ok) when running mvn integration-test -f samples/client/petstore/cpp-restsdk/client/pom.xml

[ 52%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/api/UserOrPetApi.cpp.o
[ 56%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/ApiResponse.cpp.o
[ 60%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/Category.cpp.o
[ 64%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/CreateUserOrPet_request.cpp.o
[ 68%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/Order.cpp.o
[ 72%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/Pet.cpp.o
[ 76%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/Pet_vaccinationBook.cpp.o
[ 80%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/SchemaWithSet.cpp.o
[ 84%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/SchemaWithSet_vaccinationBook.cpp.o
[ 88%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/Tag.cpp.o
[ 92%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/User.cpp.o
[ 96%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/Vaccine.cpp.o
[100%] Linking CXX static library libCppRestPetstoreClient.a
[100%] Built target CppRestPetstoreClient
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  01:26 min
[INFO] Finished at: 2024-09-16T17:32:30+08:00
[INFO] ------------------------------------------------------------------------

does it work for you locally?

how can we repeat the issue?

SaverioCode · 2024-09-17T22:16:24Z

thanks again for the PR

seems like I couldn't repeat the issue. I got the following (tests ok) when running mvn integration-test -f samples/client/petstore/cpp-restsdk/client/pom.xml

[ 52%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/api/UserOrPetApi.cpp.o
[ 56%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/ApiResponse.cpp.o
[ 60%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/Category.cpp.o
[ 64%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/CreateUserOrPet_request.cpp.o
[ 68%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/Order.cpp.o
[ 72%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/Pet.cpp.o
[ 76%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/Pet_vaccinationBook.cpp.o
[ 80%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/SchemaWithSet.cpp.o
[ 84%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/SchemaWithSet_vaccinationBook.cpp.o
[ 88%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/Tag.cpp.o
[ 92%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/User.cpp.o
[ 96%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/Vaccine.cpp.o
[100%] Linking CXX static library libCppRestPetstoreClient.a
[100%] Built target CppRestPetstoreClient
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  01:26 min
[INFO] Finished at: 2024-09-16T17:32:30+08:00
[INFO] ------------------------------------------------------------------------

does it work for you locally?

how can we repeat the issue?

The first time I got the error I was on Windows, and I created a visual studio solution to test it and I got the Linking problem.

On Linux is compiling perfectly, with both gnu and clang. From those test is not possible to caught the error.
The Linking error appear only when one of the methods (without the definition) is actually called in a program. If you create a small main.cpp just to invoke one of the missing methods your are going to have it.

On Windows running mvn integration-test -f samples/client/petstore/cpp-restsdk/client/pom.xml I got:

[INFO] --- exec:1.2.1:exec (cmake) @ CppRestPetstoreClientTests ---
CMake Warning:
  No source or binary directory provided.  Both will be assumed to be the
  same as the current working directory, but note that this warning will
  become a fatal error in future CMake releases.


-- Building for: Visual Studio 17 2022
-- Selecting Windows SDK version 10.0.22621.0 to target Windows 10.0.22631.
-- The CXX compiler identification is MSVC 19.41.34120.0
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: C:/Program Files (x86)/Microsoft Visual Studio/2022/BuildTools/VC/Tools/MSVC/14.41.34120/bin/Hostx64/x64/cl.exe - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Building client library for Windows
-- Configuring done (3.4s)
-- Generating done (0.1s)
-- Build files have been written to: C:/Users/<username>/openapi-generator/samples/client/petstore/cpp-restsdk/client
[INFO]
[INFO] --- exec:1.2.1:exec (make) @ CppRestPetstoreClientTests ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  5.916 s
[INFO] Finished at: 2024-09-18T00:11:53+02:00
[INFO] ------------------------------------------------------------------------
[INFO] 3 goals, 3 executed

SaverioCode · 2024-09-20T12:31:03Z

@muttleyxd @wing328 I changed only the missing methods implementation and the shared_ptr creation. I found out that the == operator for shared_ptr actually compare the pointers. I suppose this is why @etherealjoy introduced those checks

wing328 · 2024-10-07T06:06:03Z

local tests passed

[ 84%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/SchemaWithSet_vaccinationBook.cpp.o
[ 88%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/Tag.cpp.o
[ 92%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/User.cpp.o
[ 96%] Building CXX object CMakeFiles/CppRestPetstoreClient.dir/src/model/Vaccine.cpp.o
[100%] Linking CXX static library libCppRestPetstoreClient.a
[100%] Built target CppRestPetstoreClient
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

SaverioCode added 2 commits September 11, 2024 14:25

Fix OpenAPITools#19566 implemented the missing definition of declared…

905454d

… methods inside openapi-generator/modules/openapi-generator/src/main/resources/cpp-rest-sdk-client/modelbase-header.mustache, have also be added two missing body of methods definitions

Regenerated cpp-restsdk client samples

379a95c

muttleyxd suggested changes Sep 11, 2024

View reviewed changes

modules/openapi-generator/src/main/resources/cpp-rest-sdk-client/modelbase-header.mustache Outdated Show resolved Hide resolved

modules/openapi-generator/src/main/resources/cpp-rest-sdk-client/modelbase-header.mustache Outdated Show resolved Hide resolved

muttleyxd approved these changes Sep 12, 2024

View reviewed changes

wing328 reviewed Sep 12, 2024

View reviewed changes

wing328 added Client: C++ Issue: Bug labels Sep 16, 2024

wing328 added this to the 7.9.0 milestone Sep 16, 2024

Fixed shared_ptr creation

797ddb1

SaverioCode force-pushed the master branch from 3e8ca0f to 797ddb1 Compare September 20, 2024 11:15

SaverioCode requested a review from muttleyxd September 20, 2024 12:26

wing328 merged commit 9163e00 into OpenAPITools:master Oct 7, 2024
15 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implemented missing definitions of declared methods inside modelbase-header.mustache, added two missing body of methods definitions #19569

Implemented missing definitions of declared methods inside modelbase-header.mustache, added two missing body of methods definitions #19569

SaverioCode commented Sep 11, 2024

muttleyxd left a comment

muttleyxd commented Sep 12, 2024

wing328 Sep 12, 2024

SaverioCode Sep 12, 2024 •

edited

Loading

wing328 Sep 13, 2024

wing328 commented Sep 16, 2024

SaverioCode commented Sep 17, 2024

SaverioCode commented Sep 20, 2024

wing328 commented Oct 7, 2024

Implemented missing definitions of declared methods inside modelbase-header.mustache, added two missing body of methods definitions #19569

Implemented missing definitions of declared methods inside modelbase-header.mustache, added two missing body of methods definitions #19569

Conversation

SaverioCode commented Sep 11, 2024

PR checklist

muttleyxd left a comment

Choose a reason for hiding this comment

muttleyxd commented Sep 12, 2024

wing328 Sep 12, 2024

Choose a reason for hiding this comment

SaverioCode Sep 12, 2024 • edited Loading

Choose a reason for hiding this comment

wing328 Sep 13, 2024

Choose a reason for hiding this comment

wing328 commented Sep 16, 2024

SaverioCode commented Sep 17, 2024

SaverioCode commented Sep 20, 2024

wing328 commented Oct 7, 2024

SaverioCode Sep 12, 2024 •

edited

Loading