Skip to content

Commit

Permalink
Kafka KRaft broker creation with this GitHub Action https://github.co…
Browse files Browse the repository at this point in the history
  • Loading branch information
IharYakimush committed Apr 4, 2024
1 parent 9b53059 commit c97d0eb
Show file tree
Hide file tree
Showing 4 changed files with 117 additions and 10 deletions.
89 changes: 89 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
schedule:
- cron: '41 9 * * 1'

jobs:
analyze:
name: Analyze (${{ matrix.language }})
# Runner size impacts CodeQL analysis time. To learn more, please see:
# - https://gh.io/recommended-hardware-resources-for-running-codeql
# - https://gh.io/supported-runners-and-hardware-resources
# - https://gh.io/using-larger-runners (GitHub.com only)
# Consider using larger runners or machines with greater resources for possible analysis time improvements.
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
permissions:
# required for all workflows
security-events: write

# only required for workflows in private repositories
actions: read
contents: read

strategy:
fail-fast: false
matrix:
include:
- language: csharp
build-mode: autobuild
# CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
# Use `c-cpp` to analyze code written in C, C++ or both
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
steps:
- name: Checkout repository
uses: actions/checkout@v4

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
build-mode: ${{ matrix.build-mode }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.

# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality

# If the analyze step fails for one of the languages you are analyzing with
# "We were unable to automatically build your code", modify the matrix above
# to set the build mode to "manual" for that language. Then modify this step
# to build your code.
# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
- if: matrix.build-mode == 'manual'
run: |
echo 'If you are using a "manual" build mode for one or more of the' \
'languages you are analyzing, replace this with the commands to build' \
'your code, for example:'
echo ' make bootstrap'
echo ' make release'
exit 1
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
with:
category: "/language:${{matrix.language}}"
9 changes: 9 additions & 0 deletions .github/workflows/dotnet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,17 @@ jobs:
run: sudo ethtool -K eth0 tx off rx off
- name: Build
run: dotnet build -c Debug

- name: Run Kafka KRaft Broker
uses: spicyparrot/[email protected]
with:
kafka-version: "3.6.1"
kafka-topics: "example,1"

- name: Test
run: dotnet test -c Debug --no-build --verbosity normal --settings .runsettings
env:
KAFKA_BOOTSTRAP_SERVERS: ${{ env.kafka_runner_address }}:9093
- name: Report
run: |
dotnet tool restore
Expand Down
2 changes: 1 addition & 1 deletion Epam.Kafka.sln
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Misc", "Misc", "{A5013F6E-5
build.cmd = build.cmd
CHANGELOG.md = CHANGELOG.md
.github\CODEOWNERS = .github\CODEOWNERS
CONTRIBUTING.md = CONTRIBUTING.md
.github\workflows\codeql.yml = .github\workflows\codeql.yml
.github\workflows\dotnet.yml = .github\workflows\dotnet.yml
LICENSE.md = LICENSE.md
README.md = README.md
Expand Down
27 changes: 18 additions & 9 deletions tests/Epam.Kafka.Tests/Common/MockCluster.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,27 @@ public sealed class MockCluster : IDisposable

private const string DefaultProducer = "Default";

private readonly IAdminClient _adminClient;
private readonly IAdminClient? _adminClient;
private readonly string _mockBootstrapServers;

public MockCluster()
{
// Trick: we are going to connect with admin client first so we can get metadata and bootstrap servers from it
var clientConfig = new ClientConfig();
clientConfig.Set("bootstrap.servers", "localhost:9200");
clientConfig.Set("test.mock.num.brokers", "1");
this._adminClient = new AdminClientBuilder(clientConfig).Build();
Metadata metadata = this._adminClient.GetMetadata(TimeSpan.FromSeconds(1));
this._mockBootstrapServers = string.Join(",", metadata.Brokers.Select(b => $"{b.Host}:{b.Port}"));
string? env = Environment.GetEnvironmentVariable("KAFKA_BOOTSTRAP_SERVERS");

if (env != null)
{
this._mockBootstrapServers = env;
}
else
{
// Trick: we are going to connect with admin client first so we can get metadata and bootstrap servers from it
var clientConfig = new ClientConfig();
clientConfig.Set("bootstrap.servers", "localhost:9200");
clientConfig.Set("test.mock.num.brokers", "1");
this._adminClient = new AdminClientBuilder(clientConfig).Build();
Metadata metadata = this._adminClient.GetMetadata(TimeSpan.FromSeconds(1));
this._mockBootstrapServers = string.Join(",", metadata.Brokers.Select(b => $"{b.Host}:{b.Port}"));
}
}

public KafkaBuilder LaunchMockCluster(TestWithServices test)
Expand All @@ -37,7 +46,7 @@ public KafkaBuilder LaunchMockCluster(TestWithServices test)

public void Dispose()
{
this._adminClient.Dispose();
this._adminClient?.Dispose();
}

public static KafkaBuilder AddMockCluster(TestWithServices test, string? server = null)
Expand Down

0 comments on commit c97d0eb

Please sign in to comment.