Improve Integration Test by Generating TLS/mTLS Certificates via MSBuild

[sandy2008]

Fixes #2009
Based on PR #4731

Changes

This PR introduces an improvement in how integration tests handle TLS/mTLS certificates by generating them at build time via MSBuild. The generated certificates are stored in the build output directory.

Key Changes:

• Added MSBuild tasks to generate certificates/keys during the build process.
• Certificates are generated via PowerShell on Windows and Bash on Unix.

Merge requirement checklist

• CONTRIBUTING guidelines followed (license requirements, nullable enabled, static analysis, etc.)
• Unit tests added/updated
• Appropriate CHANGELOG.md files updated for non-trivial changes
• Changes in public API reviewed (if applicable)

License Information

THIS SOFTWARE IS CONTRIBUTED SUBJECT TO THE TERMS OF THE APACHE LICENSE V.2.0. YOU MAY OBTAIN A COPY OF THE LICENSE AT https://github.com/open-telemetry/opentelemetry-python/blob/master/LICENSE.

THIS SOFTWARE IS LICENSED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY WARRANTY OF NON-INFRINGEMENT, ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THIS SOFTWARE MAY BE REDISTRIBUTED TO OTHERS ONLY BY EFFECTIVELY USING THIS OR ANOTHER EQUIVALENT DISCLAIMER IN ADDITION TO ANY OTHER REQUIRED LICENSE TERMS.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.21%. Comparing base (6250307) to head (f6c4b00).
Report is 321 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5818      +/-   ##
==========================================
+ Coverage   83.38%   86.21%   +2.83%     
==========================================
  Files         297      257      -40     
  Lines       12531    11168    -1363     
==========================================
- Hits        10449     9629     -820     
+ Misses       2082     1539     -543     

Flag	Coverage Δ
unittests	?
unittests-Project-Experimental	86.19% <ø> (?)
unittests-Project-Stable	86.17% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 223 files with indirect coverage changes

[sandy2008]

@reyang Hi! Fixed accordingly.

[sandy2008]

@reyang Do you know what's the next step to get it merged, so that we can work on the remaining PRs to support mTLS? 🥹

[reyang]

@reyang Do you know what's the next step to get it merged, so that we can work on the remaining PRs to support mTLS? 🥹

• Check https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/CONTRIBUTING.md#how-to-get-prs-merged.
• We need at least one of the existing maintainers to review/merge the PR. Tagging @alanwest @CodeBlanch here.

[sandy2008]

@reyang @alanwest Please kindly review again!

[alanwest]

@sandy2008 try running the test locally. The CI does not pass.

[sandy2008]

@sandy2008 try running the test locally. The CI does not pass.

Sorry sorry, I forgot to push one change..

[sandy2008]

@alanwest Hmm, seems I need to give one fix, will fix it tmr.

[sandy2008]

Sorry, I was little busy during the weekend, I will work on it again today.

[sandy2008]

@alanwest Please review again, all fixed :)

[alanwest]

@sandy2008 The test is still failing.

The certs are not being written to the necessary directory

To validate that things will work, you can run this integration test locally in the same way the CI runs it

opentelemetry-dotnet/.github/workflows/ci.yml

Line 118 in c1a1931

run: docker compose --file=test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/IntegrationTest/docker-compose.yml --file=build/docker-compose.${{ matrix.version }}.yml --project-directory=. up --exit-code-from=tests --build

Be sure to run this command from the root of the repository:

docker compose --file=test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/IntegrationTest/docker-compose.yml --file=build/docker-compose.net8.0.yml --project-directory=. up --exit-code-from=tests --build

[sandy2008]

```shell
docker compose --file=test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/IntegrationTest/docker-compose.yml --file=build/docker-compose.net8.0.yml --project-directory=. up --exit-code-from=tests --build

Hi, it seems that the tests are successfully locally, is it a way that I can trigger my own tests on cloud?

opentelemetry-dotnet-tests-1           | Test Run Successful.
opentelemetry-dotnet-tests-1           | Total tests: 26
opentelemetry-dotnet-tests-1           |      Passed: 26
opentelemetry-dotnet-tests-1           |  Total time: 1.0136 Minutes
opentelemetry-dotnet-tests-1 exited with code 0
Aborting on container exit...
[+] Stopping 2/0
 ✔ Container opentelemetry-dotnet-tests-1           Stopped                0.0s 
 ✔ Container opentelemetry-dotnet-otel-collector-1  Stopped                0.1

[sandy2008]

```shell
docker compose --file=test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/IntegrationTest/docker-compose.yml --file=build/docker-compose.net8.0.yml --project-directory=. up --exit-code-from=tests --build

Hi, it seems that the tests are successfully locally, is it a way that I can trigger my own tests on cloud?

opentelemetry-dotnet-tests-1           | Test Run Successful.
opentelemetry-dotnet-tests-1           | Total tests: 26
opentelemetry-dotnet-tests-1           |      Passed: 26
opentelemetry-dotnet-tests-1           |  Total time: 1.0136 Minutes
opentelemetry-dotnet-tests-1 exited with code 0
Aborting on container exit...
[+] Stopping 2/0
 ✔ Container opentelemetry-dotnet-tests-1           Stopped                0.0s 
 ✔ Container opentelemetry-dotnet-otel-collector-1  Stopped                0.1

Oh I re-produced the error, let me fix it.