Skip to content

Commit 365ec7e

Browse files
anshooaroraanshooarora
authored
Adds ExtentKlovReporter, integration with Klov 0.2.5+ (#36)
* initial * uploads media * fix test,log to implement BasicMongoReportElement * Update ExtentKlovReporter.cs * fixes for null pointer due to description * Update ExtentKlovReporter.cs * image content without extra quotes
1 parent a4ea2cc commit 365ec7e

10 files changed

+602
-14
lines changed

‎ExtentReports/ExtentReports.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ public void AttachReporter(params IExtentReporter[] reporter)
6565
reporter.ToList().ForEach(x => Register(x));
6666
}
6767

68-
public ExtentTest CreateTest<T>(string name, string description = null) where T : IGherkinFormatterModel
68+
public ExtentTest CreateTest<T>(string name, string description = "") where T : IGherkinFormatterModel
6969
{
7070
Type type = typeof(T);
7171
var obj = (IGherkinFormatterModel)Activator.CreateInstance(type);
@@ -76,15 +76,15 @@ public ExtentTest CreateTest<T>(string name, string description = null) where T
7676
return test;
7777
}
7878

79-
public ExtentTest CreateTest(GherkinKeyword keyword, string name, string description = null)
79+
public ExtentTest CreateTest(GherkinKeyword keyword, string name, string description = "")
8080
{
8181
var test = new ExtentTest(this, name, description);
8282
test.Model.BehaviorDrivenType = keyword.Model;
8383
base.SaveTest(test.Model);
8484
return test;
8585
}
8686

87-
public ExtentTest CreateTest(string name, string description = null)
87+
public ExtentTest CreateTest(string name, string description = "")
8888
{
8989
var test = new ExtentTest(this, name, description);
9090
base.SaveTest(test.Model);

‎ExtentReports/ExtentReports.csproj

+5-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
66
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
77
<ProjectGuid>{783324EC-3D15-46A1-B34E-A1F15B97DD59}</ProjectGuid>
8-
<OutputType>Library</OutputType>
8+
<OutputType>Exe</OutputType>
99
<RootNamespace>AventStack.ExtentReports</RootNamespace>
1010
<AssemblyName>ExtentReports</AssemblyName>
1111
<TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
@@ -113,6 +113,9 @@
113113
<Compile Include="MarkupUtils\Table.cs" />
114114
<Compile Include="MediaEntityBuilder.cs" />
115115
<Compile Include="MediaEntityModelProvider.cs" />
116+
<Compile Include="MediaStorage\KlovHttpMediaManager.cs" />
117+
<Compile Include="MediaStorage\KlovMedia.cs" />
118+
<Compile Include="MediaStorage\KlovMediaStorageHandler.cs" />
116119
<Compile Include="Model\AbstractStructure.cs" />
117120
<Compile Include="Model\Attribute.cs" />
118121
<Compile Include="Model\Author.cs" />
@@ -151,6 +154,7 @@
151154
<Compile Include="Reporter\Configuration\RichViewReporterConfiguration.cs" />
152155
<Compile Include="Reporter\Configuration\Theme.cs" />
153156
<Compile Include="Reporter\ExtentHtmlReporter.cs" />
157+
<Compile Include="Reporter\ExtentKlovReporter.cs" />
154158
<Compile Include="Reporter\ExtentV3HtmlReporter.cs" />
155159
<Compile Include="Reporter\ExtentLoggerReporter.cs" />
156160
<Compile Include="Reporter\TemplateEngine\RazorEngineManager.cs" />

‎ExtentReports/ExtentTest.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ internal ExtentTest(ExtentReports extent, IGherkinFormatterModel bddType, string
2929
};
3030
}
3131

32-
internal ExtentTest(ExtentReports extent, string name, string description = null)
32+
internal ExtentTest(ExtentReports extent, string name, string description = "")
3333
: this(extent, null, name, description)
3434
{ }
3535

36-
public ExtentTest CreateNode<T>(string name, string description = null) where T : IGherkinFormatterModel
36+
public ExtentTest CreateNode<T>(string name, string description = "") where T : IGherkinFormatterModel
3737
{
3838
if (string.IsNullOrEmpty(name))
3939
throw new ArgumentException("Test name cannot be null or empty");
@@ -58,14 +58,14 @@ private void AddNodeToReport(ExtentTest node)
5858
Extent.AddNode(node.Model);
5959
}
6060

61-
public ExtentTest CreateNode(string name, string description = null)
61+
public ExtentTest CreateNode(string name, string description = "")
6262
{
6363
var node = new ExtentTest(Extent, name, description);
6464
ApplyCommonNodeSettings(node);
6565
return node;
6666
}
6767

68-
public ExtentTest CreateNode(GherkinKeyword keyword, string name, string description = null)
68+
public ExtentTest CreateNode(GherkinKeyword keyword, string name, string description = "")
6969
{
7070
var node = new ExtentTest(Extent, name, description);
7171
node.Model.BehaviorDrivenType = keyword.Model;

‎ExtentReports/MediaStorage/KlovHttpMediaManager.cs

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
using AventStack.ExtentReports.Model;
2+
3+
using System;
4+
using System.Collections.Generic;
5+
using System.Globalization;
6+
using System.IO;
7+
using System.Net;
8+
using System.Net.Http;
9+
using System.Net.Http.Headers;
10+
using System.Runtime.CompilerServices;
11+
12+
namespace AventStack.ExtentReports.MediaStorage
13+
{
14+
internal class KlovHttpMediaManager
15+
{
16+
private const string Route = "files/upload";
17+
18+
private string _host;
19+
20+
public void Init(string host)
21+
{
22+
if (!host.Substring(host.Length - 1).Equals("/"))
23+
{
24+
host += "/";
25+
}
26+
_host = host;
27+
}
28+
29+
[MethodImpl(MethodImplOptions.Synchronized)]
30+
public void StoreMedia(Media m)
31+
{
32+
if (string.IsNullOrEmpty(m.Path) || !string.IsNullOrEmpty(m.Base64String))
33+
{
34+
return;
35+
}
36+
37+
if (!File.Exists(m.Path))
38+
{
39+
throw new IOException("The system cannot find the file specified " + m.Path);
40+
}
41+
42+
var uri = new Uri(_host);
43+
var file = File.ReadAllBytes(m.Path);
44+
var fileName = m.Sequence + Path.GetExtension(m.Path);
45+
46+
using (var reader = new StreamReader(m.Path))
47+
{
48+
using (var handler = new HttpClientHandler() { UseCookies = false })
49+
using (var client = new HttpClient(handler))
50+
{
51+
client.BaseAddress = uri;
52+
53+
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
54+
client.DefaultRequestHeaders.Add("Accept", "application/json");
55+
client.DefaultRequestHeaders.Add("Connection", "keep-alive");
56+
client.DefaultRequestHeaders.Add("User-Agent", "Mozilla/5.0");
57+
58+
using (var content = new MultipartFormDataContent(DateTime.Now.ToString(CultureInfo.InvariantCulture)))
59+
{
60+
string logId = m.LogObjectId == null ? "" : m.LogObjectId.ToString();
61+
62+
var values = new[]
63+
{
64+
new KeyValuePair<string, string>("name", m.Sequence + Path.GetExtension(m.Path)),
65+
new KeyValuePair<string, string>("id", m.ObjectId.ToString()),
66+
new KeyValuePair<string, string>("reportId", m.ReportObjectId.ToString()),
67+
new KeyValuePair<string, string>("testId", m.TestObjectId.ToString()),
68+
new KeyValuePair<string, string>("mediaType", "img"),
69+
new KeyValuePair<string, string>("logId", logId)
70+
};
71+
72+
foreach (var keyValuePair in values)
73+
{
74+
content.Add(new StringContent(keyValuePair.Value), String.Format("\"{0}\"", keyValuePair.Key));
75+
}
76+
77+
var imageContent = new ByteArrayContent(file);
78+
content.Add(imageContent, "f", fileName);
79+
80+
var result = client.PostAsync(_host + Route, content).Result;
81+
82+
if (result.StatusCode != HttpStatusCode.OK)
83+
{
84+
throw new IOException("Unable to upload file to server: " + m.Path);
85+
}
86+
}
87+
}
88+
}
89+
}
90+
}
91+
}

‎ExtentReports/MediaStorage/KlovMedia.cs

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
using MongoDB.Bson;
2+
using MongoDB.Driver;
3+
4+
namespace AventStack.ExtentReports.MediaStorage
5+
{
6+
internal class KlovMedia
7+
{
8+
public ObjectId ProjectId { get; set; }
9+
public ObjectId ReportId { get; set; }
10+
public IMongoCollection<BsonDocument> MediaCollection { get; set; }
11+
}
12+
}

‎ExtentReports/MediaStorage/KlovMediaStorageHandler.cs

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
using AventStack.ExtentReports.Model;
2+
3+
using MongoDB.Bson;
4+
5+
using System;
6+
7+
namespace AventStack.ExtentReports.MediaStorage
8+
{
9+
internal class KlovMediaStorageHandler
10+
{
11+
public KlovMediaStorageHandler(string url, KlovMedia media)
12+
{
13+
if (string.IsNullOrEmpty(url))
14+
{
15+
throw new ArgumentException("Invalid URL or resource not found");
16+
}
17+
18+
_klovmedia = media;
19+
_mediamanager = new KlovHttpMediaManager();
20+
_mediamanager.Init(url);
21+
}
22+
23+
public void SaveScreenCapture(BasicMongoReportElement el, ScreenCapture media)
24+
{
25+
var document = new BsonDocument
26+
{
27+
{ "project", _klovmedia.ProjectId },
28+
{ "report", _klovmedia.ReportId },
29+
{ "sequence", media.Sequence },
30+
{ "mediaType", "img" },
31+
{ "test", media.TestObjectId }
32+
};
33+
34+
if (el is Test)
35+
{
36+
document.Add("testName", ((Test)el).Name);
37+
}
38+
else
39+
{
40+
document.Add("log", el.ObjectId);
41+
}
42+
43+
_klovmedia.MediaCollection.InsertOne(document);
44+
var id = document["_id"].AsObjectId;
45+
media.ObjectId = id;
46+
media.ReportObjectId = _klovmedia.ReportId;
47+
_mediamanager.StoreMedia(media);
48+
}
49+
50+
private KlovHttpMediaManager _mediamanager;
51+
private KlovMedia _klovmedia;
52+
}
53+
}

‎ExtentReports/Model/Log.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@
88
namespace AventStack.ExtentReports.Model
99
{
1010
[Serializable]
11-
public class Log : IRunResult
11+
public class Log : BasicMongoReportElement, IRunResult
1212
{
1313
public DateTime Timestamp { get => _timestamp; set => _timestamp = value; }
1414
public Status Status { get; set; }
1515
public ObjectId ObjectId { get => _objectId; set => _objectId = value; }
1616
public Test Test { get; private set; }
17-
public string Details { get; set; }
17+
public string Details { get; set; } = string.Empty;
1818
public int Sequence = 0;
1919
public IMarkup Markup { get; set; }
2020
public ExceptionInfo ExceptionInfo { get; set; }

‎ExtentReports/Model/StatusHierarchy.cs

+18-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
using System.Collections.Generic;
1+
using AventStack.ExtentReports.Utils;
2+
3+
using System.Collections.Generic;
24

35
namespace AventStack.ExtentReports.Model
46
{
@@ -19,5 +21,20 @@ public static List<Status> GetStatusHierarchy()
1921
{
2022
return _statusHierarchy;
2123
}
24+
25+
public static Status GetHighestStatus(List<Status> list)
26+
{
27+
var highestStatus = Status.Pass;
28+
if (list.IsNullOrEmpty())
29+
{
30+
return highestStatus;
31+
}
32+
33+
foreach (var status in list)
34+
{
35+
highestStatus = GetStatusHierarchy().IndexOf(status) < GetStatusHierarchy().IndexOf(highestStatus)? status: highestStatus;
36+
}
37+
return highestStatus;
38+
}
2239
}
2340
}

‎ExtentReports/Model/Test.cs

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
using AventStack.ExtentReports.Gherkin.Model;
1+
using AventStack.ExtentReports.Core;
2+
using AventStack.ExtentReports.Gherkin.Model;
23

34
using MongoDB.Bson;
45

@@ -9,10 +10,10 @@
910
namespace AventStack.ExtentReports.Model
1011
{
1112
[Serializable]
12-
public class Test
13+
public class Test : BasicMongoReportElement, IRunResult
1314
{
1415
public string Name { get; set; }
15-
public string Description { get; set; }
16+
public string Description { get; set; } = string.Empty;
1617
public int TestId { get; } = Interlocked.Increment(ref _cntr);
1718
public ObjectId ObjectId { get; set; }
1819
public Status Status { get; set; } = Status.Pass;

0 commit comments

Comments
 (0)