Download and enable grpcurl in ptf docker. by ryanzhu706 · Pull Request #24587 · sonic-net/sonic-buildimage

ryanzhu706 · 2025-11-20T19:22:03Z

Why I did it

Added grpcurl binary to PTF Docker containers to enable gRPC testing capabilities for SONiC test framework. This supports upcoming gNOI (gRPC Network Operations Interface) testing infrastructure that requires a lightweight gRPC client tool.

Background:

SONiC is moving towards gRPC-based management interfaces (gNMI, gNOI, gNSI)
Current test framework lacks unified gRPC testing capabilities
grpcurl provides a simple, dependency-free solution for gRPC operations
Eliminates need for protocol buffer compilation in test environments

Work item tracking

Microsoft ADO (number only):

How I did it

Download and enable grpcurl in ptf docker

Why I did it

Added grpcurl binary to PTF Docker containers to enable gRPC testing capabilities for SONiC test framework. This supports upcoming gNOI (gRPC Network Operations Interface) testing infrastructure that requires a lightweight gRPC client tool.
Background:

SONiC is moving towards gRPC-based management interfaces (gNMI, gNOI, gNSI)
Current test framework lacks unified gRPC testing capabilities
grpcurl provides a simple, dependency-free solution for gRPC operations
Eliminates need for protocol buffer compilation in test environments

How I did it

Added grpcurl v1.9.1 installation to PTF Dockerfile during build process
Implemented multi-architecture support (armhf, arm64, x86_64)
Downloads official release binary from GitHub releases
Installs to standard location /usr/local/bin/grpcurl
Properly sets executable permissions
Technical Details:
Uses conditional architecture detection via CONFIGURED_ARCH
Downloads from https://github.com/fullstorydev/grpcurl/releases
Cleans up temporary files to minimize image size
Version 1.9.1 chosen for stability and feature completeness

How to verify it

Build PTF container with changes

Verify grpcurl is installed:

docker exec ptf-container which grpcurl
# Should return: /usr/local/bin/grpcurl

Test grpcurl functionality:

docker exec ptf-container grpcurl -version
# Should return: grpcurl v1.9.1

Test against live gRPC endpoint (if available):

docker exec ptf-container grpcurl -plaintext <dut-ip>:8080 list
# Should list available gRPC services

Description for the changelog

Add grpcurl v1.9.1 to PTF Docker container for gRPC testing support

Dependencies/Related Work

Supports upcoming gNOI client library implementation in sonic-mgmt
Enables gRPC-based test cases without complex proto compilation
Foundation for unified gNMI/gNOI/gNSI testing infrastructure

Additional Notes

No impact on existing PTF functionality
Minimal size increase (~24MB for grpcurl binary)
No runtime dependencies added
Compatible with all supported SONiC architectures%

How to verify it

Download and enable grpcurl in ptf docker

Why I did it

Added grpcurl binary to PTF Docker containers to enable gRPC testing capabilities for SONiC test framework. This supports upcoming gNOI (gRPC Network Operations Interface) testing infrastructure that requires a lightweight gRPC client tool.
Background:

SONiC is moving towards gRPC-based management interfaces (gNMI, gNOI, gNSI)
Current test framework lacks unified gRPC testing capabilities
grpcurl provides a simple, dependency-free solution for gRPC operations
Eliminates need for protocol buffer compilation in test environments

How I did it

Added grpcurl v1.9.1 installation to PTF Dockerfile during build process
Implemented multi-architecture support (armhf, arm64, x86_64)
Downloads official release binary from GitHub releases
Installs to standard location /usr/local/bin/grpcurl
Properly sets executable permissions
Technical Details:
Uses conditional architecture detection via CONFIGURED_ARCH
Downloads from https://github.com/fullstorydev/grpcurl/releases
Cleans up temporary files to minimize image size
Version 1.9.1 chosen for stability and feature completeness

How to verify it

Build PTF container with changes

Verify grpcurl is installed:

docker exec ptf-container which grpcurl
# Should return: /usr/local/bin/grpcurl

Test grpcurl functionality:

docker exec ptf-container grpcurl -version
# Should return: grpcurl v1.9.1

Test against live gRPC endpoint (if available):

docker exec ptf-container grpcurl -plaintext <dut-ip>:8080 list
# Should list available gRPC services

Description for the changelog

Add grpcurl v1.9.1 to PTF Docker container for gRPC testing support

Dependencies/Related Work

Supports upcoming gNOI client library implementation in sonic-mgmt
Enables gRPC-based test cases without complex proto compilation
Foundation for unified gNMI/gNOI/gNSI testing infrastructure

Additional Notes

No impact on existing PTF functionality
Minimal size increase (~24MB for grpcurl binary)
No runtime dependencies added
Compatible with all supported SONiC architectures%

Which release branch to backport (provide reason below if selected)

Tested branch (Please provide the tested image version)

Description for the changelog

Link to config_db schema for YANG module changes

A picture of a cute animal (not mandatory but encouraged)

mssonicbld · 2025-11-20T19:22:11Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-11-20T19:22:32Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull Request Overview

This PR adds the grpcurl tool (version 1.9.1) to the PTF (Packet Test Framework) Docker image. The tool is downloaded as a pre-compiled binary from GitHub releases and installed to /usr/local/bin/grpcurl. This enables gRPC testing capabilities within the PTF environment.

Key changes:

Downloads and installs grpcurl 1.9.1 binary from GitHub releases
Integrates the installation into the existing apt-get RUN command chain
Cleans up temporary files after installation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

dockers/docker-ptf/Dockerfile.j2

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

mssonicbld · 2025-11-20T23:42:33Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-11-20T23:42:45Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull Request Overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-20T23:48:35Z

dockers/docker-ptf/Dockerfile.j2

+      -o /tmp/grpcurl_${GRPCURL_VERSION}_${GRPCURL_ARCH}.tar.gz && \
+    cd /tmp && \
+    tar xvf grpcurl_${GRPCURL_VERSION}_${GRPCURL_ARCH}.tar.gz && \
+    mv grpcurl /usr/local/bin/grpcurl && \
+    chmod +x /usr/local/bin/grpcurl && \
+    rm -f /tmp/grpcurl_${GRPCURL_VERSION}_${GRPCURL_ARCH}.tar.gz && \


The grpcurl download lacks checksum verification, which poses a security risk. Consider adding SHA256 checksum verification after downloading to ensure the integrity and authenticity of the downloaded binary. This prevents potential security vulnerabilities from compromised or tampered packages.

Suggested change

-o /tmp/grpcurl_${GRPCURL_VERSION}_${GRPCURL_ARCH}.tar.gz && \

cd /tmp && \

tar xvf grpcurl_${GRPCURL_VERSION}_${GRPCURL_ARCH}.tar.gz && \

mv grpcurl /usr/local/bin/grpcurl && \

chmod +x /usr/local/bin/grpcurl && \

rm -f /tmp/grpcurl_${GRPCURL_VERSION}_${GRPCURL_ARCH}.tar.gz && \

-o /tmp/grpcurl_${GRPCURL_VERSION}_${GRPCURL_ARCH}.tar.gz && \

curl -L "https://github.com/fullstorydev/grpcurl/releases/download/v${GRPCURL_VERSION}/checksums.txt" \

-o /tmp/grpcurl_${GRPCURL_VERSION}_checksums.txt && \

cd /tmp && \

grep "grpcurl_${GRPCURL_VERSION}_${GRPCURL_ARCH}.tar.gz" grpcurl_${GRPCURL_VERSION}_checksums.txt > grpcurl_${GRPCURL_VERSION}_${GRPCURL_ARCH}.sha256 && \

sha256sum -c grpcurl_${GRPCURL_VERSION}_${GRPCURL_ARCH}.sha256 && \

tar xvf grpcurl_${GRPCURL_VERSION}_${GRPCURL_ARCH}.tar.gz && \

mv grpcurl /usr/local/bin/grpcurl && \

chmod +x /usr/local/bin/grpcurl && \

rm -f /tmp/grpcurl_${GRPCURL_VERSION}_${GRPCURL_ARCH}.tar.gz && \

rm -f /tmp/grpcurl_${GRPCURL_VERSION}_checksums.txt && \

rm -f /tmp/grpcurl_${GRPCURL_VERSION}_${GRPCURL_ARCH}.sha256 && \

hdwhdw · 2025-12-03T19:34:53Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-12-03T19:35:00Z

Commenter does not have sufficient privileges for PR 24587 in repo sonic-net/sonic-buildimage

mssonicbld · 2025-12-03T19:43:52Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-12-03T19:44:06Z

Azure Pipelines successfully started running 1 pipeline(s).

Added grpcurl binary to PTF Docker containers to enable gRPC testing capabilities for SONiC test framework. This supports upcoming gNOI (gRPC Network Operations Interface) testing infrastructure that requires a lightweight gRPC client tool. Background: SONiC is moving towards gRPC-based management interfaces (gNMI, gNOI, gNSI) Current test framework lacks unified gRPC testing capabilities grpcurl provides a simple, dependency-free solution for gRPC operations Eliminates need for protocol buffer compilation in test environments Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Ying Xie <yxieca@users.noreply.github.com>

Added grpcurl binary to PTF Docker containers to enable gRPC testing capabilities for SONiC test framework. This supports upcoming gNOI (gRPC Network Operations Interface) testing infrastructure that requires a lightweight gRPC client tool. Background: SONiC is moving towards gRPC-based management interfaces (gNMI, gNOI, gNSI) Current test framework lacks unified gRPC testing capabilities grpcurl provides a simple, dependency-free solution for gRPC operations Eliminates need for protocol buffer compilation in test environments Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Ying Xie <yxieca@users.noreply.github.com> Signed-off-by: Dawei Huang <daweihuang@microsoft.com>

Added grpcurl binary to PTF Docker containers to enable gRPC testing capabilities for SONiC test framework. This supports upcoming gNOI (gRPC Network Operations Interface) testing infrastructure that requires a lightweight gRPC client tool. Background: SONiC is moving towards gRPC-based management interfaces (gNMI, gNOI, gNSI) Current test framework lacks unified gRPC testing capabilities grpcurl provides a simple, dependency-free solution for gRPC operations Eliminates need for protocol buffer compilation in test environments Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Ying Xie <yxieca@users.noreply.github.com> Signed-off-by: xiaweijiang <xiaweijiang@microsoft.com>

Added grpcurl binary to PTF Docker containers to enable gRPC testing capabilities for SONiC test framework. This supports upcoming gNOI (gRPC Network Operations Interface) testing infrastructure that requires a lightweight gRPC client tool. Background: SONiC is moving towards gRPC-based management interfaces (gNMI, gNOI, gNSI) Current test framework lacks unified gRPC testing capabilities grpcurl provides a simple, dependency-free solution for gRPC operations Eliminates need for protocol buffer compilation in test environments Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Ying Xie <yxieca@users.noreply.github.com>

Added grpcurl binary to PTF Docker containers to enable gRPC testing capabilities for SONiC test framework. This supports upcoming gNOI (gRPC Network Operations Interface) testing infrastructure that requires a lightweight gRPC client tool. Background: SONiC is moving towards gRPC-based management interfaces (gNMI, gNOI, gNSI) Current test framework lacks unified gRPC testing capabilities grpcurl provides a simple, dependency-free solution for gRPC operations Eliminates need for protocol buffer compilation in test environments Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Ying Xie <yxieca@users.noreply.github.com> Signed-off-by: Feng Pan <fenpan@microsoft.com>

Download grpcurl in ptf docker.

c8356e6

ryanzhu706 requested a review from lguohan as a code owner November 20, 2025 19:22

Copilot AI review requested due to automatic review settings November 20, 2025 19:22

Copilot started reviewing on behalf of ryanzhu706 November 20, 2025 19:22 View session

Copilot finished reviewing on behalf of ryanzhu706 November 20, 2025 19:24

Copilot AI reviewed Nov 20, 2025

View reviewed changes

dockers/docker-ptf/Dockerfile.j2 Outdated Show resolved Hide resolved

dockers/docker-ptf/Dockerfile.j2 Outdated Show resolved Hide resolved

dockers/docker-ptf/Dockerfile.j2 Outdated Show resolved Hide resolved

dockers/docker-ptf/Dockerfile.j2 Show resolved Hide resolved

Update dockers/docker-ptf/Dockerfile.j2

82a22b3

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings November 20, 2025 23:42

Copilot started reviewing on behalf of ryanzhu706 November 20, 2025 23:46 View session

Copilot finished reviewing on behalf of ryanzhu706 November 20, 2025 23:48

Copilot AI reviewed Nov 20, 2025

View reviewed changes

vaibhavhd requested a review from hdwhdw December 2, 2025 20:11

hdwhdw approved these changes Dec 3, 2025

View reviewed changes

Merge branch 'master' into grpcurl_in_ptf

46f6637

yxieca merged commit 9f5a96e into sonic-net:master Dec 5, 2025
22 of 23 checks passed

Conversation

ryanzhu706 commented Nov 20, 2025 • edited by yxieca Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why I did it

Work item tracking

How I did it

Download and enable grpcurl in ptf docker

Why I did it

How I did it

How to verify it

Description for the changelog

Dependencies/Related Work

Additional Notes

How to verify it

Download and enable grpcurl in ptf docker

Why I did it

How I did it

How to verify it

Description for the changelog

Dependencies/Related Work

Additional Notes

Which release branch to backport (provide reason below if selected)

Tested branch (Please provide the tested image version)

Description for the changelog

Link to config_db schema for YANG module changes

A picture of a cute animal (not mandatory but encouraged)

Uh oh!

mssonicbld commented Nov 20, 2025

Uh oh!

azure-pipelines bot commented Nov 20, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mssonicbld commented Nov 20, 2025

Uh oh!

azure-pipelines bot commented Nov 20, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Nov 20, 2025

Choose a reason for hiding this comment

Uh oh!

hdwhdw commented Dec 3, 2025

Uh oh!

azure-pipelines bot commented Dec 3, 2025

Uh oh!

mssonicbld commented Dec 3, 2025

Uh oh!

azure-pipelines bot commented Dec 3, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ryanzhu706 commented Nov 20, 2025 •

edited by yxieca

Loading