-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[receiver/mysqlreceiver] Add integration test (#6916)
* Add integration test * Update Changelog * Add to test modules
- Loading branch information
Mrod1598
authored
Dec 21, 2021
1 parent
6e055ca
commit 36a284a
Showing
8 changed files
with
693 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| //go:build integration | ||
| // +build integration | ||
|
|
||
| package mysqlreceiver | ||
|
|
||
| import ( | ||
| "context" | ||
| "net" | ||
| "path" | ||
| "path/filepath" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| "github.com/testcontainers/testcontainers-go" | ||
| "github.com/testcontainers/testcontainers-go/wait" | ||
| "go.opentelemetry.io/collector/component/componenttest" | ||
| "go.opentelemetry.io/collector/consumer/consumertest" | ||
|
|
||
| "github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest" | ||
| "github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest/golden" | ||
| "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/mysqlreceiver/internal/metadata" | ||
| ) | ||
|
|
||
| func TestMySqlIntegration(t *testing.T) { | ||
| t.Run("Running mysql version 8.0", func(t *testing.T) { | ||
| t.Parallel() | ||
| container := getContainer(t, containerRequest8_0) | ||
| defer func() { | ||
| require.NoError(t, container.Terminate(context.Background())) | ||
| }() | ||
| hostname, err := container.Host(context.Background()) | ||
| require.NoError(t, err) | ||
|
|
||
| f := NewFactory() | ||
| cfg := f.CreateDefaultConfig().(*Config) | ||
| cfg.Endpoint = net.JoinHostPort(hostname, "3306") | ||
| cfg.Username = "otel" | ||
| cfg.Password = "otel" | ||
|
|
||
| consumer := new(consumertest.MetricsSink) | ||
| settings := componenttest.NewNopReceiverCreateSettings() | ||
| rcvr, err := f.CreateMetricsReceiver(context.Background(), settings, cfg, consumer) | ||
| require.NoError(t, err, "failed creating metrics receiver") | ||
| require.NoError(t, rcvr.Start(context.Background(), componenttest.NewNopHost())) | ||
| require.Eventuallyf(t, func() bool { | ||
| return len(consumer.AllMetrics()) > 0 | ||
| }, 2*time.Minute, 1*time.Second, "failed to receive more than 0 metrics") | ||
|
|
||
| md := consumer.AllMetrics()[0] | ||
| require.Equal(t, 1, md.ResourceMetrics().Len()) | ||
| ilms := md.ResourceMetrics().At(0).InstrumentationLibraryMetrics() | ||
| require.Equal(t, 1, ilms.Len()) | ||
| metrics := ilms.At(0).Metrics() | ||
| require.NoError(t, rcvr.Shutdown(context.Background())) | ||
|
|
||
| require.Equal(t, len(metadata.M.Names()), metrics.Len()) | ||
| }) | ||
|
|
||
| t.Run("Running mysql version 5.7", func(t *testing.T) { | ||
| t.Parallel() | ||
| container := getContainer(t, containerRequest5_7) | ||
| defer func() { | ||
| require.NoError(t, container.Terminate(context.Background())) | ||
| }() | ||
| hostname, err := container.Host(context.Background()) | ||
| require.NoError(t, err) | ||
|
|
||
| f := NewFactory() | ||
| cfg := f.CreateDefaultConfig().(*Config) | ||
| cfg.Endpoint = net.JoinHostPort(hostname, "3307") | ||
| cfg.Username = "otel" | ||
| cfg.Password = "otel" | ||
|
|
||
| consumer := new(consumertest.MetricsSink) | ||
| settings := componenttest.NewNopReceiverCreateSettings() | ||
| rcvr, err := f.CreateMetricsReceiver(context.Background(), settings, cfg, consumer) | ||
| require.NoError(t, err, "failed creating metrics receiver") | ||
| require.NoError(t, rcvr.Start(context.Background(), componenttest.NewNopHost())) | ||
| require.Eventuallyf(t, func() bool { | ||
| return len(consumer.AllMetrics()) > 0 | ||
| }, 2*time.Minute, 1*time.Second, "failed to receive more than 0 metrics") | ||
|
|
||
| md := consumer.AllMetrics()[0] | ||
| require.Equal(t, 1, md.ResourceMetrics().Len()) | ||
| ilms := md.ResourceMetrics().At(0).InstrumentationLibraryMetrics() | ||
| require.Equal(t, 1, ilms.Len()) | ||
| aMetricSlice := ilms.At(0).Metrics() | ||
| require.NoError(t, rcvr.Shutdown(context.Background())) | ||
|
|
||
| expectedFile := filepath.Join("testdata", "scraper", "expected.json") | ||
| expectedMetrics, err := golden.ReadMetrics(expectedFile) | ||
| require.NoError(t, err) | ||
| eMetricSlice := expectedMetrics.ResourceMetrics().At(0).InstrumentationLibraryMetrics().At(0).Metrics() | ||
|
|
||
| scrapertest.CompareMetricSlices(eMetricSlice, aMetricSlice, scrapertest.IgnoreValues()) | ||
| }) | ||
| } | ||
|
|
||
| var ( | ||
| containerRequest5_7 = testcontainers.ContainerRequest{ | ||
| FromDockerfile: testcontainers.FromDockerfile{ | ||
| Context: path.Join(".", "testdata", "integration"), | ||
| Dockerfile: "Dockerfile.mysql.5_7", | ||
| }, | ||
| ExposedPorts: []string{"3307:3306"}, | ||
| WaitingFor: wait.ForListeningPort("3306"). | ||
| WithStartupTimeout(2 * time.Minute), | ||
| } | ||
| containerRequest8_0 = testcontainers.ContainerRequest{ | ||
| FromDockerfile: testcontainers.FromDockerfile{ | ||
| Context: path.Join(".", "testdata", "integration"), | ||
| Dockerfile: "Dockerfile.mysql.8_0", | ||
| }, | ||
| ExposedPorts: []string{"3306:3306"}, | ||
| WaitingFor: wait.ForListeningPort("3306"). | ||
| WithStartupTimeout(2 * time.Minute), | ||
| } | ||
| ) | ||
|
|
||
| func getContainer(t *testing.T, req testcontainers.ContainerRequest) testcontainers.Container { | ||
| require.NoError(t, req.Validate()) | ||
| container, err := testcontainers.GenericContainer( | ||
| context.Background(), | ||
| testcontainers.GenericContainerRequest{ | ||
| ContainerRequest: req, | ||
| Started: true, | ||
| }) | ||
| require.NoError(t, err) | ||
|
|
||
| code, err := container.Exec(context.Background(), []string{"/setup.sh"}) | ||
| require.NoError(t, err) | ||
| require.Equal(t, 0, code) | ||
| return container | ||
| } |
13 changes: 13 additions & 0 deletions
13
receiver/mysqlreceiver/testdata/integration/Dockerfile.mysql.5_7
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| FROM mysql:5.7 | ||
|
|
||
| RUN \ | ||
| apt-get update && \ | ||
| apt-get install -y libmariadb3 | ||
|
|
||
| COPY scripts/setup.sh /setup.sh | ||
| RUN chmod +x /setup.sh | ||
|
|
||
| ENV MYSQL_DATABASE=otel | ||
| ENV MYSQL_USER=otel | ||
| ENV MYSQL_PASSWORD=otel | ||
| ENV MYSQL_ROOT_PASSWORD=otel |
13 changes: 13 additions & 0 deletions
13
receiver/mysqlreceiver/testdata/integration/Dockerfile.mysql.8_0
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| FROM mysql:8.0 | ||
|
|
||
| RUN \ | ||
| apt-get update && \ | ||
| apt-get install -y libmariadb3 | ||
|
|
||
| COPY scripts/setup.sh /setup.sh | ||
| RUN chmod +x /setup.sh | ||
|
|
||
| ENV MYSQL_DATABASE=otel | ||
| ENV MYSQL_USER=otel | ||
| ENV MYSQL_PASSWORD=otel | ||
| ENV MYSQL_ROOT_PASSWORD=otel |
29 changes: 29 additions & 0 deletions
29
receiver/mysqlreceiver/testdata/integration/scripts/setup.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| set -e | ||
|
|
||
| USER="otel" | ||
| ROOT_PASS="otel" | ||
| CODE=1 | ||
|
|
||
|
|
||
| setup_permissions() { | ||
| # NOTE: -pPASSWORD is missing a space on purpose | ||
| mysql -u root -p"${ROOT_PASS}" -e "GRANT PROCESS ON *.* TO ${USER}" > /dev/null | ||
| mysql -u root -p"${ROOT_PASS}" -e "GRANT SELECT ON INFORMATION_SCHEMA.INNODB_METRICS TO ${USER}" > /dev/null | ||
| mysql -u root -p"${ROOT_PASS}" -e "FLUSH PRIVILEGES" > /dev/null | ||
| } | ||
|
|
||
| echo "Configuring ${USER} permissions. . ." | ||
| end=$((SECONDS+60)) | ||
| while [ $SECONDS -lt $end ]; do | ||
| result="$?" | ||
| if setup_permissions; then | ||
| echo "Permissions configured!" | ||
| exit 0 | ||
| fi | ||
| echo "Trying again in 5 seconds. . ." | ||
| sleep 5 | ||
| done | ||
|
|
||
| echo "Failed to configure permissions" |