[braft] New port by Gab-Menezes · Pull Request #23830 · microsoft/vcpkg

Gab-Menezes · 2022-03-29T01:34:11Z

Describe the pull request
New port for braft

Which triplets are supported/not supported? Have you updated the CI baseline?

Linux, No
Does your PR follow the maintainer guide?

Not yet, I am still working on this PR
If you have added/updated a port: Have you run ./vcpkg x-add-version --all and committed the result?

Not yet, I am still working on this PR

If you are still working on the PR, open it as a Draft: https://github.blog/2019-02-14-introducing-draft-pull-requests/

ghost · 2022-03-29T01:34:22Z

All CLA requirements met.

JackBoosY · 2022-03-29T01:36:31Z

Can you please sign CLA first?

github-actions

This is a new experimental fast check for PR issues. Please let us know if this bot is helpful!

All manifest files must be formatted

./vcpkg format-manifest ports/*/vcpkg.json

Diff

diff --git a/ports/braft/vcpkg.json b/ports/braft/vcpkg.json
index b054486..cf28ed4 100644
--- a/ports/braft/vcpkg.json
+++ b/ports/braft/vcpkg.json
@@ -1,23 +1,23 @@
-{
-    "name": "braft",
-    "version-date": "2021-26-04",
-    "description": "Consesus algorithm library",
-    "homepage": "https://github.com/baidu/braft",
-    "supports": "!windows",
-    "dependencies": [
-        {
-            "name": "vcpkg-cmake",
-            "host": true
-        },
-        {
-            "name": "vcpkg-cmake-config",
-            "host": true
-        },
-        "brpc",
-        "protobuf",
-        "leveldb",
-        "gflags",
-        "glog",
-        "thrift"
-    ]
-}
+{
+  "name": "braft",
+  "version-date": "2021-26-04",
+  "description": "Consesus algorithm library",
+  "homepage": "https://github.com/baidu/braft",
+  "supports": "!windows",
+  "dependencies": [
+    "brpc",
+    "gflags",
+    "glog",
+    "leveldb",
+    "protobuf",
+    "thrift",
+    {
+      "name": "vcpkg-cmake",
+      "host": true
+    },
+    {
+      "name": "vcpkg-cmake-config",
+      "host": true
+    }
+  ]
+}

After committing all other changes, the version database must be updated

git add -u && git commit
git checkout 773516ecf6014d89cc69b11bb54605ad4be56694 -- versions
./vcpkg x-add-version --all

Diff

diff --git a/versions/baseline.json b/versions/baseline.json
index 316e85c..901aa86 100644
--- a/versions/baseline.json
+++ b/versions/baseline.json
@@ -1132,6 +1132,10 @@
       "baseline": "2.4.1",
       "port-version": 2
     },
+    "braft": {
+      "baseline": "2021-26-04",
+      "port-version": 0
+    },
     "breakpad": {
       "baseline": "2020-09-14",
       "port-version": 5

You have modified or added at least one vcpkg.json where a "license" field is missing.

Details

If you feel able to do so, please consider adding a "license" field to the following files:

ports/braft/vcpkg.json

Valid values for the license field can be found in the documentation

Gab-Menezes · 2022-03-29T01:37:38Z

Done

Gab-Menezes · 2022-03-29T01:39:55Z

If you remove the install step of the patch, the library will compile fine as I said. But we can't reference it in another cmake scripts

github-actions

You have modified or added at least one vcpkg.json where a "license" field is missing.

Details

If you feel able to do so, please consider adding a "license" field to the following files:

ports/braft/vcpkg.json

Valid values for the license field can be found in the documentation

github-actions

You have modified or added at least one vcpkg.json where a "license" field is missing.

Details

If you feel able to do so, please consider adding a "license" field to the following files:

ports/braft/vcpkg.json

Valid values for the license field can be found in the documentation

JackBoosY · 2022-03-29T02:37:25Z

ports/braft/export-target.patch

+         )
+ endif()
+
+install(EXPORT unofficial-braftConfig


All the dependency's styles are absolute path, so we don't need find_dependency.

github-actions

You have modified or added at least one vcpkg.json where a "license" field is missing.

Details

If you feel able to do so, please consider adding a "license" field to the following files:

ports/braft/vcpkg.json

Valid values for the license field can be found in the documentation

JackBoosY · 2022-03-29T06:18:31Z

@Gab-Menezes Can you please test the changes?

Gab-Menezes · 2022-03-30T02:28:50Z

Hey, so with the changes it the install process went fine fine. So tried linking braft in test binary using

cmake_minimum_required(VERSION 3.20)
project(test)

find_package(unofficial-braft CONFIG REQUIRED)

add_executable(main main.cpp)
target_link_libraries(main PRIVATE unofficial::braft::braft-static)

And the c++ program just have the main function returning 0.
But I got this error when trying to to compile (the configuration step went fine)

[ 50%] Building CXX object CMakeFiles/main.dir/main.cpp.o
make[2]: *** No rule to make target '/mnt/c/dev/vcpkg-dev/vcpkg/installed/x64-linux/debug/lib/libgflags.a', needed by 'main'. 
 Stop.
make[1]: *** [CMakeFiles/Makefile2:83: CMakeFiles/main.dir/all] Error 2
make: *** [Makefile:91: all] Error 2

If I try to link gflags manually

cmake_minimum_required(VERSION 3.20)
project(test)

find_package(unofficial-braft CONFIG REQUIRED)
find_package(gflags CONFIG REQUIRED)

add_executable(main main.cpp)
target_link_libraries(main PRIVATE gflags::gflags)
target_link_libraries(main PRIVATE unofficial::braft::braft-static)

I get the same error, but if I remove the braft link and link only gflags everything is fine

cmake_minimum_required(VERSION 3.20)
project(test)

find_package(gflags CONFIG REQUIRED)

add_executable(main main.cpp)
target_link_libraries(main PRIVATE gflags::gflags)

So I looked at the lib and /debug/lib folders

As we can see the debug/lib folder has a _debug suffix, but he expected name doesn't have this suffix.

The linking is fine in release mode (by just linking braft, not needing to link gflags manually), so I tried calling anything from braft to see if it was fine

#include <iostream>
#include <braft/raft.h>

int main()
{
    braft::PeerId leader;
    return 0;
}

And got an error saying braft/raft.h is not in the include directories

/mnt/c/dev/vcpkg-dev/tests/main.cpp:2:10: fatal error: braft/raft.h: No such file or directory
    2 | #include <braft/raft.h>
      |          ^~~~~~~~~~~~~~
compilation terminated.
make[2]: *** [CMakeFiles/main.dir/build.make:76: CMakeFiles/main.dir/main.cpp.o] Error 1
make[1]: *** [CMakeFiles/Makefile2:83: CMakeFiles/main.dir/all] Error 2
make: *** [Makefile:91: all] Error 2

After this can you talk me through what you have done, I would love to learn more and maybe create a PR to export brpc.

JackBoosY · 2022-03-30T02:43:02Z

As we can see the debug/lib folder has a _debug suffix, but he expected name doesn't have this suffix.

We should find all kind of gflags.

And got an error saying braft/raft.h is not in the include directories

Okay, will export only path level include.

JackBoosY · 2022-04-01T10:05:06Z

I will handle this tomorrow.

github-actions

This is a new experimental fast check for PR issues. Please let us know if this bot is helpful!

PRs must add only one version and must not modify any published versions

When making any changes to a library, the version or port-version in vcpkg.json or CONTROL must be modified.

Error: Local changes detected for braft but no changes to version or port version.
-- Version: 2021-26-04
-- Old SHA: 78874b8ee402a9025a9bcc8662c5f30461231273
-- New SHA: 1e440378c483c1d3a12a666f5f0163bbd3103715
-- Did you remember to update the version or port version?
-- Pass `--overwrite-version` to bypass this check.
***No files were updated.***

JackBoosY · 2022-04-02T08:52:00Z

@Gab-Menezes Please test again.

Thanks.

Gab-Menezes · 2022-04-02T20:26:45Z

So the configuration step is not working here is the log (running with --debug flag) (I also deleted all the reference to braft to guarantee that it's not a cache problem)
config-x64-linux-dbg-err.log
config-x64-linux-dbg-out.log
console.txt

dg0yt · 2022-04-04T06:10:23Z

grep: GFLAGS_INCLUDE_PATH-NOTFOUND/gflags/gflags_declare.h: No such file or directory
CMake Error at CMakeLists.txt:191 (if):
  if given arguments:

    "STREQUAL" "GFLAGS_NAMESPACE"

  Unknown arguments specified

This usually comes from a statement like:

if(${empyt_var} STREQUAL "GFLAGS_NAMESPACE")

Either you find out why it is empty/unset, or you add quotes:

if("${empyt_var}" STREQUAL "GFLAGS_NAMESPACE")

JackBoosY · 2022-04-06T09:02:46Z

@Gab-Menezes Should be good now.

Gab-Menezes · 2022-04-07T00:39:54Z

@JackBoosY Yay it compiles when linking to another project, only one thing. We need do link gflags manually if not we get:

CMake Error at /mnt/c/dev/vcpkg-dev/vcpkg/scripts/buildsystems/vcpkg.cmake:559 (_add_executable):
  Target "main" links to target "gflags::gflags" but the target was not
  found.  Perhaps a find_package() call is missing for an IMPORTED target, or
  an ALIAS target is missing?
Call Stack (most recent call first):
  CMakeLists.txt:6 (add_executable)

Even though I didn't include nothing from glfags, but if we find and link, it works fine.

Gab-Menezes · 2022-04-07T00:41:31Z

In the near future I will try to do the brpc one (I'm kinda busy right now). If I have any problem can I ask for your help @JackBoosY ? (I will try to use this one as a reference)

JackBoosY · 2022-04-07T02:16:52Z

@Gab-Menezes Ah I forgot this, sorry.
We already have port grpc. can you please check whether it suitable for you?

Gab-Menezes · 2022-04-07T02:17:55Z

Yes I know we have, but it's not exported (I'm talking about brpc (braft uses brpc), not grpc)

JackBoosY · 2022-04-07T02:33:55Z

Yes I know we have, but it's not exported (I'm talking about brpc (braft uses brpc), not grpc)

Okay, I will take a look at that.

JackBoosY · 2022-04-07T07:13:05Z

@Gab-Menezes This time it should be okay, I promised.
You will no need to find and use gflags manually.

Gab-Menezes · 2022-04-07T23:41:20Z

@JackBoosY It's working perfectly without needing to link gflags manually.

strega-nil-ms · 2022-04-08T22:26:46Z

Thanks!

* master: (139 commits) [dstorage] Add port for Microsoft.Direct3D.DirectStorage NuGet (microsoft#24063) [vcpkg] Refactor toolchain & generator selection (microsoft#23846) [icu] update to 70.1 (microsoft#23445) [vcpkg] Update android usage documentation (microsoft#23690) [LMDB] update to 0.9.29 (microsoft#24045) [catch2] Don't install docs (microsoft#24046) [harfbuff] fix arm64 osx build (microsoft#24055) [openxr-loader] remove from CI baseline (microsoft#24057) [imath] Update to 3.1.5 (microsoft#24059) [openssl] Fix dynamic builds on UNIX (microsoft#24061) [c-ares] update to 1.18.1 (microsoft#24062) [igraph] update to 0.9.8 (microsoft#24065) [cmake-user] Fix library check (microsoft#24070) [openxr-loader] fix ci.baseline.txt (microsoft#24073) [tinycbor] Fix file conflicts with libcbor (microsoft#24056) [graphviz,libslirp] Limit msys to windows (microsoft#24032) [bdwgc] Don't build docs (microsoft#24025) [capstone] update to 5.0.0-rc2 (microsoft#23979) [clockutils] Fix x64-windows-static-md (microsoft#23965) [braft] New port (microsoft#23830) ...

creating braft port

ac87db1

Gab-Menezes mentioned this pull request Mar 29, 2022

[New Port Request] braft #22763

Closed

JackBoosY self-assigned this Mar 29, 2022

JackBoosY added the category:new-port The issue is requesting a new library to be added; consider making a PR! label Mar 29, 2022

github-actions bot requested changes Mar 29, 2022

View reviewed changes

format manifest

a5ca2b6

version

62efcdf

github-actions bot approved these changes Mar 29, 2022

View reviewed changes

JackBoosY added 2 commits March 28, 2022 19:35

Refix

68e6c5f

version

15fee71

github-actions bot approved these changes Mar 29, 2022

View reviewed changes

JackBoosY reviewed Mar 29, 2022

View reviewed changes

JackBoosY added 2 commits March 28, 2022 20:05

Add dependency brpc

3ddfa6b

version

6888865

github-actions bot approved these changes Mar 29, 2022

View reviewed changes

JackBoosY added 2 commits March 28, 2022 20:08

Add license

3380603

version

1a2df9d

github-actions bot approved these changes Mar 29, 2022

View reviewed changes

JackBoosY added 2 commits April 2, 2022 01:50

Fix dependency gflags, fix export include path

b23c7a4

version

c6acbc7

github-actions bot requested changes Apr 2, 2022

View reviewed changes

github-actions bot approved these changes Apr 2, 2022

View reviewed changes

JackBoosY added 2 commits April 2, 2022 02:00

Re-fix dependency

3a60218

version

33b0a8f

github-actions bot approved these changes Apr 2, 2022

View reviewed changes

JackBoosY added 2 commits April 5, 2022 23:07

Re-fix gflags

1bb2a58

version

ef8a57a

github-actions bot approved these changes Apr 6, 2022

View reviewed changes

JackBoosY marked this pull request as ready for review April 6, 2022 09:02

JackBoosY added 2 commits April 7, 2022 00:10

Add find_dependency

db766e2

version

a3300fe

github-actions bot approved these changes Apr 7, 2022

View reviewed changes

JackBoosY approved these changes Apr 8, 2022

View reviewed changes

JackBoosY added the info:needs-maintainer-attention Lets the current 'on rotation' vcpkg maintainer know they need to look at this. label Apr 8, 2022

strega-nil-ms merged commit 8fc4b4b into microsoft:master Apr 8, 2022

Conversation

Gab-Menezes commented Mar 29, 2022

Which triplets are supported/not supported? Have you updated the CI baseline?

Does your PR follow the maintainer guide?

If you have added/updated a port: Have you run ./vcpkg x-add-version --all and committed the result?

Uh oh!

ghost commented Mar 29, 2022 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JackBoosY commented Mar 29, 2022

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Gab-Menezes commented Mar 29, 2022

Uh oh!

Gab-Menezes commented Mar 29, 2022

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

JackBoosY Mar 29, 2022

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

JackBoosY commented Mar 29, 2022

Uh oh!

Gab-Menezes commented Mar 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JackBoosY commented Mar 30, 2022

Uh oh!

JackBoosY commented Apr 1, 2022

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

JackBoosY commented Apr 2, 2022

Uh oh!

Gab-Menezes commented Apr 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dg0yt commented Apr 4, 2022

Uh oh!

JackBoosY commented Apr 6, 2022

Uh oh!

Gab-Menezes commented Apr 7, 2022

Uh oh!

Gab-Menezes commented Apr 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JackBoosY commented Apr 7, 2022

Uh oh!

Gab-Menezes commented Apr 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JackBoosY commented Apr 7, 2022

Uh oh!

JackBoosY commented Apr 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Gab-Menezes commented Apr 7, 2022

Uh oh!

strega-nil-ms commented Apr 8, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

If you have added/updated a port: Have you run `./vcpkg x-add-version --all` and committed the result?

ghost commented Mar 29, 2022 •

edited by ghost

Loading

Gab-Menezes commented Mar 30, 2022 •

edited

Loading

Gab-Menezes commented Apr 2, 2022 •

edited

Loading

Gab-Menezes commented Apr 7, 2022 •

edited

Loading

Gab-Menezes commented Apr 7, 2022 •

edited

Loading

JackBoosY commented Apr 7, 2022 •

edited

Loading