Skip to content

fix: validate configuration when is client configured via file #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 7, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
## 1.15.0 [unreleased]

### Bug Fixes
1. [#143](https://github.com/influxdata/influxdb-client-csharp/pull/143): Added validation that a configuration is present when is client configured via file

### CI
1. [#140](https://github.com/influxdata/influxdb-client-csharp/pull/140): Updated default docker image to v2.0.3

Expand Down
7 changes: 7 additions & 0 deletions Client.Test/App.config
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
<configuration>
<configSections>
<section name="influx2" type="InfluxDB.Client.Configurations.Influx2, InfluxDB.Client" />
<section name="influx2-without-url" type="InfluxDB.Client.Configurations.Influx2, InfluxDB.Client" />
</configSections>
<appSettings>
<add key="SensorVersion" value="v1.00"/>
Expand All @@ -20,4 +21,10 @@
<tag name="version" value="${SensorVersion}"/>
</tags>
</influx2>
<influx2-without-url org="my-org"
bucket="my-bucket"
token="my-token"
logLevel="BODY"
readWriteTimeout="5s"
timeout="10s" />
</configuration>
37 changes: 32 additions & 5 deletions Client.Test/InfluxDbClientFactoryTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,7 @@ public void LoadFromConnectionUnknownUnit()
[Test]
public void LoadFromConfiguration()
{
// copy App.config to assemble format
var config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
File.Copy(Directory.GetCurrentDirectory() + "/../../../App.config", config.FilePath, true);
CopyAppConfig();

var client = InfluxDBClientFactory.Create();

Expand All @@ -145,7 +143,29 @@ public void LoadFromConfiguration()
Assert.AreEqual("California Miner", defaultTags["customer"]);
Assert.AreEqual("${SensorVersion}", defaultTags["version"]);
}


[Test]
public void LoadFromConfigurationWithoutUrl()
{
CopyAppConfig();

var ce = Assert.Throws<ConfigurationErrorsException>(() => InfluxDBClientOptions.Builder
.CreateNew()
.LoadConfig("influx2-without-url"));

StringAssert.StartsWith("Required attribute 'url' not found.", ce.Message);
}

[Test]
public void LoadFromConfigurationNotExist()
{
var ce = Assert.Throws<ConfigurationErrorsException>(() => InfluxDBClientOptions.Builder
.CreateNew()
.LoadConfig("influx2-not-exits"));

StringAssert.StartsWith("The configuration doesn't contains a 'influx2'", ce.Message);
}

[Test]
public void V1Configuration()
{
Expand Down Expand Up @@ -188,7 +208,14 @@ private static T GetDeclaredField<T>(IReflect type, object instance, string fiel
const BindingFlags bindFlags = BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic
| BindingFlags.Static | BindingFlags.DeclaredOnly;
var field = type.GetField(fieldName, bindFlags);
return (T) field.GetValue(instance);
return (T) field?.GetValue(instance);
}

private static void CopyAppConfig()
{
// copy App.config to assemble format
var config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
File.Copy(Directory.GetCurrentDirectory() + "/../../../App.config", config.FilePath, true);
}
}
}
14 changes: 1 addition & 13 deletions Client.Test/ItWriteApiRaceTest.cs
Original file line number Diff line number Diff line change
@@ -1,16 +1,9 @@
using System;
using System.Collections.Generic;
using System.Configuration;
using System.Diagnostics;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using InfluxDB.Client.Api.Domain;
using InfluxDB.Client.Core;
using InfluxDB.Client.Writes;
using NodaTime;
using NUnit.Framework;
using Duration = NodaTime.Duration;
using Task = System.Threading.Tasks.Task;

namespace InfluxDB.Client.Test
{
Expand Down Expand Up @@ -58,11 +51,6 @@ public class ItWriteApiRaceTest : AbstractItClientTest
[Test]
public void Race()
{
var options = new InfluxDBClientOptions.Builder().Url(InfluxDbUrl)
.LoadConfig()
.Url(InfluxDbUrl)
.AuthenticateToken(_token)
.Build();
var point = PointData.Measurement("race-test")
.Tag("test", "stress")
.Field("value", 1);
Expand Down
2 changes: 1 addition & 1 deletion Client.Test/ItWriteQueryApiTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ public async Task DefaultTagsConfiguration()
{
Client.Dispose();

var options = new InfluxDBClientOptions.Builder().Url(InfluxDbUrl)
var options = new InfluxDBClientOptions.Builder()
.LoadConfig()
.Url(InfluxDbUrl)
.AuthenticateToken(_token)
Expand Down
30 changes: 20 additions & 10 deletions Client/InfluxDBClientOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -248,20 +248,30 @@ public Builder AddDefaultTag(string tagName, string expression)
/// <summary>
/// Configure Builder via App.config.
/// </summary>
/// <param name="sectionName">Name of configuration section. Useful for tests.</param>
/// <returns><see cref="Builder"/></returns>
internal Builder LoadConfig()
internal Builder LoadConfig(string sectionName = "influx2")
{
var config = (Influx2) ConfigurationManager.GetSection("influx2");
var config = (Influx2) ConfigurationManager.GetSection(sectionName);
if (config == null)
{
const string message = "The configuration doesn't contains a 'influx2' section. " +
"The minimal configuration should contains an url of InfluxDB. " +
"For more details see: " +
"https://github.com/influxdata/influxdb-client-csharp/blob/master/Client/README.md#client-configuration-file";

throw new ConfigurationErrorsException(message);
}

var url = config?.Url;
var org = config?.Org;
var bucket = config?.Bucket;
var token = config?.Token;
var logLevel = config?.LogLevel;
var timeout = config?.Timeout;
var readWriteTimeout = config?.ReadWriteTimeout;
var url = config.Url;
var org = config.Org;
var bucket = config.Bucket;
var token = config.Token;
var logLevel = config.LogLevel;
var timeout = config.Timeout;
var readWriteTimeout = config.ReadWriteTimeout;

var tags = config?.Tags;
var tags = config.Tags;
if (tags != null)
{
foreach (Influx2.TagElement o in tags)
Expand Down