From 47361447f89a1abd36365ea8da7822eeb8b58d3c Mon Sep 17 00:00:00 2001 From: Wael Nasreddine Date: Fri, 5 Jun 2020 13:29:26 -0700 Subject: [PATCH 1/2] nanopb: init at 0.4.1 --- pkgs/development/libraries/nanopb/default.nix | 81 +++++++++++++++++++ .../libraries/nanopb/protoc-gen-nanopb | 3 + pkgs/top-level/all-packages.nix | 2 + 3 files changed, 86 insertions(+) create mode 100644 pkgs/development/libraries/nanopb/default.nix create mode 100644 pkgs/development/libraries/nanopb/protoc-gen-nanopb diff --git a/pkgs/development/libraries/nanopb/default.nix b/pkgs/development/libraries/nanopb/default.nix new file mode 100644 index 000000000000..92d56386f0f4 --- /dev/null +++ b/pkgs/development/libraries/nanopb/default.nix @@ -0,0 +1,81 @@ +{ callPackage +, cmake +, fetchFromGitHub +, lib +, protobuf +, python3 +, stdenv +}: + +let + pythonRuntime = python3.withPackages(ps: [ ps.protobuf ]); +in stdenv.mkDerivation rec { + pname = "nanopb"; + version = "0.4.1"; + + src = fetchFromGitHub { + owner = pname; + repo = pname; + rev = version; + sha256 = "16zxk42wzn519bpxf4578qn97k0h1cnbkvqqkqvka9sl0n3lz2dp"; + }; + + nativeBuildInputs = [ cmake python3 ]; + + cmakeFlags = [ + "-DBUILD_SHARED_LIBS=ON" # generate $out/lib/libprotobuf-nanopb.so{.0,} + "-DBUILD_STATIC_LIBS=ON" # generate $out/lib/libprotobuf-nanopb.a + "-Dnanopb_PROTOC_PATH=${protobuf}/bin/protoc" + ]; + + # On a case-insensitive filesystem (such as on Darwin), CMake fails to create + # the build directory because of the existence of the BUILD file. + # TODO: This can be removed once https://github.com/nanopb/nanopb/pull/537 is merged. + preConfigure = "rm BUILD"; + + # install the generator which requires Python3 with the protobuf package. It + # also requires the nanopb module that's generated by CMake to be in a + # relative location to the generator itself so we move it out of the + # python.sitePackages into the shared generator folder. + postInstall = '' + mkdir -p $out/share/nanopb/generator/proto + cp ../generator/nanopb_generator.py $out/share/nanopb/generator/nanopb_generator.py + cp ../generator/proto/_utils.py $out/share/nanopb/generator/proto/_utils.py + cp ../generator/proto/nanopb.proto $out/share/nanopb/generator/proto/nanopb.proto + mv $out/${python3.sitePackages}/nanopb_pb2.py $out/share/nanopb/generator/proto + rm -rf $out/${python3.sitePackages} + + mkdir $out/bin + substitute ${./protoc-gen-nanopb} $out/bin/protoc-gen-nanopb \ + --subst-var-by python ${pythonRuntime}/bin/python \ + --subst-var-by out $out + chmod +x $out/bin/protoc-gen-nanopb + ''; + + meta = with lib; { + inherit (protobuf.meta) platforms; + + description = "Protocol Buffers with small code size"; + homepage = "https://jpa.kapsi.fi/nanopb/"; + license = licenses.zlib; + maintainers = with maintainers; [ kalbasit ]; + + longDescription = '' + Nanopb is a small code-size Protocol Buffers implementation in ansi C. It + is especially suitable for use in microcontrollers, but fits any memory + restricted system. + + - Homepage: jpa.kapsi.fi/nanopb + - Documentation: jpa.kapsi.fi/nanopb/docs + - Downloads: jpa.kapsi.fi/nanopb/download + - Forum: groups.google.com/forum/#!forum/nanopb + + In order to use the nanopb options in your proto files, you'll need to + tell protoc where to find the nanopb.proto file. + You can do so with the --proto_path (-I) option to add the directory + ''${nanopb}/share/nanopb/generator/proto like so: + + protoc --proto_path=. --proto_path=''${nanopb}/share/nanopb/generator/proto --plugin=protoc-gen-nanopb=''${nanopb}/bin/protoc-gen-nanopb --nanopb_out=out file.proto + ''; + }; +} diff --git a/pkgs/development/libraries/nanopb/protoc-gen-nanopb b/pkgs/development/libraries/nanopb/protoc-gen-nanopb new file mode 100644 index 000000000000..764e6614b18a --- /dev/null +++ b/pkgs/development/libraries/nanopb/protoc-gen-nanopb @@ -0,0 +1,3 @@ +#!/usr/bin/env bash + +exec @python@ @out@/share/nanopb/generator/nanopb_generator.py --protoc-plugin diff --git a/pkgs/top-level/all-packages.nix b/pkgs/top-level/all-packages.nix index e7fc5edf06b3..58e5c3d86f1e 100644 --- a/pkgs/top-level/all-packages.nix +++ b/pkgs/top-level/all-packages.nix @@ -14170,6 +14170,8 @@ in flatbuffers = callPackage ../development/libraries/flatbuffers { }; + nanopb = callPackage ../development/libraries/nanopb { }; + gnupth = callPackage ../development/libraries/pth { }; pth = if stdenv.hostPlatform.isMusl then npth else gnupth; From c0810058bee79ce9b2959657d0fb13882e3b9bbc Mon Sep 17 00:00:00 2001 From: Wael Nasreddine Date: Fri, 5 Jun 2020 13:29:52 -0700 Subject: [PATCH 2/2] nanopb: add tests via passthru.tests --- pkgs/development/libraries/nanopb/default.nix | 7 +++++ .../test-message-with-annotations/default.nix | 27 +++++++++++++++++++ .../withannotations.proto | 7 +++++ .../test-message-with-options/default.nix | 27 +++++++++++++++++++ .../withoptions.options | 1 + .../withoptions.proto | 5 ++++ .../nanopb/test-simple-proto2/default.nix | 24 +++++++++++++++++ .../nanopb/test-simple-proto2/simple.proto | 5 ++++ .../nanopb/test-simple-proto3/default.nix | 24 +++++++++++++++++ .../nanopb/test-simple-proto3/simple.proto | 5 ++++ 10 files changed, 132 insertions(+) create mode 100644 pkgs/development/libraries/nanopb/test-message-with-annotations/default.nix create mode 100644 pkgs/development/libraries/nanopb/test-message-with-annotations/withannotations.proto create mode 100644 pkgs/development/libraries/nanopb/test-message-with-options/default.nix create mode 100644 pkgs/development/libraries/nanopb/test-message-with-options/withoptions.options create mode 100644 pkgs/development/libraries/nanopb/test-message-with-options/withoptions.proto create mode 100644 pkgs/development/libraries/nanopb/test-simple-proto2/default.nix create mode 100644 pkgs/development/libraries/nanopb/test-simple-proto2/simple.proto create mode 100644 pkgs/development/libraries/nanopb/test-simple-proto3/default.nix create mode 100644 pkgs/development/libraries/nanopb/test-simple-proto3/simple.proto diff --git a/pkgs/development/libraries/nanopb/default.nix b/pkgs/development/libraries/nanopb/default.nix index 92d56386f0f4..a63d367b800d 100644 --- a/pkgs/development/libraries/nanopb/default.nix +++ b/pkgs/development/libraries/nanopb/default.nix @@ -52,6 +52,13 @@ in stdenv.mkDerivation rec { chmod +x $out/bin/protoc-gen-nanopb ''; + passthru.tests = { + simple-proto2 = callPackage ./test-simple-proto2 {}; + simple-proto3 = callPackage ./test-simple-proto3 {}; + message-with-annotations = callPackage ./test-message-with-annotations {}; + message-with-options = callPackage ./test-message-with-options {}; + }; + meta = with lib; { inherit (protobuf.meta) platforms; diff --git a/pkgs/development/libraries/nanopb/test-message-with-annotations/default.nix b/pkgs/development/libraries/nanopb/test-message-with-annotations/default.nix new file mode 100644 index 000000000000..618d7c521ce0 --- /dev/null +++ b/pkgs/development/libraries/nanopb/test-message-with-annotations/default.nix @@ -0,0 +1,27 @@ +{ stdenv, protobuf, nanopb }: + +stdenv.mkDerivation { + name = "nanopb-test-message-with-annotations"; + meta.timeout = 60; + src = ./.; + + # protoc requires any .proto file to be compiled to reside within it's + # proto_path. By default the current directory is automatically added to the + # proto_path. I tried using --proto_path ${./.} ${./simple.proto} and it did + # not work because they end up in the store at different locations. + installPhase = ":"; + buildPhase = '' + mkdir $out + + ${protobuf}/bin/protoc --proto_path=. --proto_path=${nanopb}/share/nanopb/generator/proto --plugin=protoc-gen-nanopb=${nanopb}/bin/protoc-gen-nanopb --nanopb_out=$out withannotations.proto + ''; + + docheck = true; + checkphase = '' + grep -q WithAnnotations $out/withannotations.pb.c || (echo "error: WithAnnotations not found in $out/withannotations.pb.c"; exit 1) + grep -q WithAnnotations $out/withannotations.pb.h || (echo "error: WithAnnotations not found in $out/withannotations.pb.h"; exit 1) + grep -q "pb_byte_t uuid\[16\]" $out/withannotations.pb.h || (echo "error: uuid is not of type pb_byte_t and of size 16 in $out/withannotations.pb.h"; exit 1) + grep -q "FIXED_LENGTH_BYTES, uuid" $out/withannotations.pb.h || (echo "error: uuid is not of fixed lenght bytes in $out/withannotations.pb.h"; exit 1) + grep -q "#define WithAnnotations_size" $out/withannotations.pb.h || (echo "error: the size of WithAnnotations is not known in $out/withannotations.pb.h"; exit 1) + ''; +} diff --git a/pkgs/development/libraries/nanopb/test-message-with-annotations/withannotations.proto b/pkgs/development/libraries/nanopb/test-message-with-annotations/withannotations.proto new file mode 100644 index 000000000000..d8109e877d68 --- /dev/null +++ b/pkgs/development/libraries/nanopb/test-message-with-annotations/withannotations.proto @@ -0,0 +1,7 @@ +syntax = "proto3"; + +import "nanopb.proto"; + +message WithAnnotations { + bytes uuid = 1 [(nanopb).max_size = 16, (nanopb).fixed_length = true]; +} diff --git a/pkgs/development/libraries/nanopb/test-message-with-options/default.nix b/pkgs/development/libraries/nanopb/test-message-with-options/default.nix new file mode 100644 index 000000000000..c15b51f71977 --- /dev/null +++ b/pkgs/development/libraries/nanopb/test-message-with-options/default.nix @@ -0,0 +1,27 @@ +{ stdenv, protobuf, nanopb }: + +stdenv.mkDerivation { + name = "nanopb-test-message-with-options"; + meta.timeout = 60; + src = ./.; + + # protoc requires any .proto file to be compiled to reside within it's + # proto_path. By default the current directory is automatically added to the + # proto_path. I tried using --proto_path ${./.} ${./simple.proto} and it did + # not work because they end up in the store at different locations. + installPhase = ":"; + buildPhase = '' + mkdir $out + + ${protobuf}/bin/protoc --plugin=protoc-gen-nanopb=${nanopb}/bin/protoc-gen-nanopb --nanopb_out=$out withoptions.proto + ''; + + docheck = true; + checkphase = '' + grep -q WithOptions $out/withoptions.pb.c || (echo "error: WithOptions not found in $out/withoptions.pb.c"; exit 1) + grep -q WithOptions $out/withoptions.pb.h || (echo "error: WithOptions not found in $out/withoptions.pb.h"; exit 1) + grep -q "pb_byte_t uuid\[16\]" $out/withoptions.pb.h || (echo "error: uuid is not of type pb_byte_t and of size 16 in $out/withoptions.pb.h"; exit 1) + grep -q "FIXED_LENGTH_BYTES, uuid" $out/withoptions.pb.h || (echo "error: uuid is not of fixed lenght bytes in $out/withoptions.pb.h"; exit 1) + grep -q "#define WithOptions_size" $out/withoptions.pb.h || (echo "error: the size of WithOptions is not known in $out/withoptions.pb.h"; exit 1) + ''; +} diff --git a/pkgs/development/libraries/nanopb/test-message-with-options/withoptions.options b/pkgs/development/libraries/nanopb/test-message-with-options/withoptions.options new file mode 100644 index 000000000000..ecf98a217367 --- /dev/null +++ b/pkgs/development/libraries/nanopb/test-message-with-options/withoptions.options @@ -0,0 +1 @@ + WithOptions.uuid max_size:16 fixed_length:true diff --git a/pkgs/development/libraries/nanopb/test-message-with-options/withoptions.proto b/pkgs/development/libraries/nanopb/test-message-with-options/withoptions.proto new file mode 100644 index 000000000000..5a5da3a1c973 --- /dev/null +++ b/pkgs/development/libraries/nanopb/test-message-with-options/withoptions.proto @@ -0,0 +1,5 @@ +syntax = "proto3"; + +message WithOptions { + bytes uuid = 1; +} diff --git a/pkgs/development/libraries/nanopb/test-simple-proto2/default.nix b/pkgs/development/libraries/nanopb/test-simple-proto2/default.nix new file mode 100644 index 000000000000..a915e7785370 --- /dev/null +++ b/pkgs/development/libraries/nanopb/test-simple-proto2/default.nix @@ -0,0 +1,24 @@ +{ stdenv, protobuf, nanopb }: + +stdenv.mkDerivation { + name = "nanopb-test-simple-proto2"; + meta.timeout = 60; + src = ./.; + + # protoc requires any .proto file to be compiled to reside within it's + # proto_path. By default the current directory is automatically added to the + # proto_path. I tried using --proto_path ${./.} ${./simple.proto} and it did + # not work because they end up in the store at different locations. + installPhase = ":"; + buildPhase = '' + mkdir $out + + ${protobuf}/bin/protoc --plugin=protoc-gen-nanopb=${nanopb}/bin/protoc-gen-nanopb --nanopb_out=$out simple.proto + ''; + + doCheck = true; + checkPhase = '' + grep -q SimpleMessage $out/simple.pb.c || (echo "ERROR: SimpleMessage not found in $out/simple.pb.c"; exit 1) + grep -q SimpleMessage $out/simple.pb.h || (echo "ERROR: SimpleMessage not found in $out/simple.pb.h"; exit 1) + ''; +} diff --git a/pkgs/development/libraries/nanopb/test-simple-proto2/simple.proto b/pkgs/development/libraries/nanopb/test-simple-proto2/simple.proto new file mode 100644 index 000000000000..b02936b1ae26 --- /dev/null +++ b/pkgs/development/libraries/nanopb/test-simple-proto2/simple.proto @@ -0,0 +1,5 @@ +syntax = "proto2"; + +message SimpleMessage { + required int32 lucky_number = 1; +} diff --git a/pkgs/development/libraries/nanopb/test-simple-proto3/default.nix b/pkgs/development/libraries/nanopb/test-simple-proto3/default.nix new file mode 100644 index 000000000000..3e2bba731b9f --- /dev/null +++ b/pkgs/development/libraries/nanopb/test-simple-proto3/default.nix @@ -0,0 +1,24 @@ +{ stdenv, protobuf, nanopb }: + +stdenv.mkDerivation { + name = "nanopb-test-simple-proto3"; + meta.timeout = 60; + src = ./.; + + # protoc requires any .proto file to be compiled to reside within it's + # proto_path. By default the current directory is automatically added to the + # proto_path. I tried using --proto_path ${./.} ${./simple.proto} and it did + # not work because they end up in the store at different locations. + installPhase = ":"; + buildPhase = '' + mkdir $out + + ${protobuf}/bin/protoc --plugin=protoc-gen-nanopb=${nanopb}/bin/protoc-gen-nanopb --nanopb_out=$out simple.proto + ''; + + doCheck = true; + checkPhase = '' + grep -q SimpleMessage $out/simple.pb.c || (echo "ERROR: SimpleMessage not found in $out/simple.pb.c"; exit 1) + grep -q SimpleMessage $out/simple.pb.h || (echo "ERROR: SimpleMessage not found in $out/simple.pb.h"; exit 1) + ''; +} diff --git a/pkgs/development/libraries/nanopb/test-simple-proto3/simple.proto b/pkgs/development/libraries/nanopb/test-simple-proto3/simple.proto new file mode 100644 index 000000000000..6b99cdb5daa7 --- /dev/null +++ b/pkgs/development/libraries/nanopb/test-simple-proto3/simple.proto @@ -0,0 +1,5 @@ +syntax = "proto3"; + +message SimpleMessage { + int32 lucky_number = 1; +}