15063454499

Committed 16 May 2025 07:49AM UTC coverage: 87.586% (-3.5%) from 91.081%

Build # 15063454499

Build Type

Pull #195

github

Committed by

web-flow

Commit Message

Merge 84e18a9a7 into 9f1f537c4

Pull Request Pull Request #195: 189 Go Live

Run Details

476 of 600 branches covered (79.33%)

Branch coverage included in aggregate %.

175 of 203 new or added lines in 21 files covered. (86.21%)

96 existing lines in 13 files now uncovered.

2706 of 3033 relevant lines covered (89.22%)

23.02 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.38

/source/components/Kyameru.Component.Ftp/Implementation/From.cs

﻿using Kyameru.Component.Ftp.Contracts;
using Kyameru.Component.Ftp.Settings;
using Kyameru.Core.Contracts;
using Kyameru.Core.Entities;
using System;
using System.Collections.Generic;
using System.Net;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Timers;
using Kyameru.Core;
using Kyameru.Core.Sys;
using Timer = System.Timers.Timer;

namespace Kyameru.Component.Ftp
{
    /// <summary>
    /// FTP From Component
    /// </summary>
    /// <remarks>
    /// Async not really implemented, needs more work and should really be using sftp.
    /// </remarks>
    public class From : IFtpFrom
    {
        private readonly FtpSettings ftpSettings;
        private readonly IWebRequestUtility webRequestUtility;
        private FtpClient ftp;
        private Timer poller;

        private bool _isStopping = false;

        /// <summary>
        /// Initializes a new instance of the <see cref="From"/> class.
        /// </summary>
        /// <param name="headers"></param>
        public From(Dictionary<string, string> headers, IWebRequestUtility webRequestUtility)
        {
            ftpSettings = new FtpSettings(headers.ToFromConfig());
            this.webRequestUtility = webRequestUtility;
        }

        public bool PollerIsActive => poller.Enabled;

        public event AsyncEventHandler<RoutableEventData> OnActionAsync;

        /// <summary>
        /// Event raised when logging.
        /// </summary>
        public event EventHandler<Log> OnLog;

        /// <summary>
        /// Sets up the component.
        /// </summary>
        public void Setup()
        {
            ftp = new FtpClient(ftpSettings, webRequestUtility);
            poller = new Timer(ftpSettings.PollTime);
            poller.Elapsed += Poller_Elapsed;
            poller.AutoReset = true;
            ftp.OnDownloadFile += Ftp_OnDownloadFile;
            ftp.OnLog += Ftp_OnLog;
            ftp.OnError += Ftp_OnError;
            webRequestUtility.OnLog += WebRequestUtility_OnLog;
        }

        /// <summary>
        /// Event triggered when timer elapses.
        /// </summary>
        /// <param name="sender">Object sending the event.</param>
        /// <param name="e">Elapsed arguments.</param>
        private void Poller_Elapsed(object sender, ElapsedEventArgs e)
        {
            if (!_isStopping)
            {
                ftp.Poll();
            }
            else
            {
                poller.Stop();
            }
        }

        /// <summary>
        /// Logs an error event.
        /// </summary>
        /// <param name="sender">Object sending the event.</param>
        /// <param name="e">Exception being raised.</param>
        private void Ftp_OnError(object sender, Exception e)
        {
            OnLog?.Invoke(this, new Log(Microsoft.Extensions.Logging.LogLevel.Error, Resources.ERROR_FTPPROCESSING, e));
        }

        /// <summary>
        /// Event raised when logging.
        /// </summary>
        /// <param name="sender">Object sending</param>
        /// <param name="e">Event message.</param>
        private void Ftp_OnLog(object sender, string e)
        {
            OnLog?.Invoke(this, new Log(Microsoft.Extensions.Logging.LogLevel.Information, e));
        }

        /// <summary>
        /// Event raised when file is downloaded.
        /// </summary>
        /// <param name="sender">Object sending the event.</param>
        /// <param name="e">Message to route.</param>
        private void Ftp_OnDownloadFile(object sender, Routable e)
        {
            OnActionAsync?.Invoke(this, new RoutableEventData(e, new CancellationToken()));
        }

        public async Task StartAsync(CancellationToken cancellationToken)
        {
            if (!cancellationToken.IsCancellationRequested)
            {
                ftp.Poll();
                poller.Start();
            }

            await Task.CompletedTask;
        }

        public async Task StopAsync(CancellationToken cancellationToken)
        {
            _isStopping = true;
            poller.AutoReset = false;
            poller.Stop();
            poller.Enabled = false;
            await Task.CompletedTask;
        }

        private void WebRequestUtility_OnLog(object sender, string e)
        {
            OnLog?.Invoke(this, new Log(Microsoft.Extensions.Logging.LogLevel.Information, e));
        }
    }
}

1	using Kyameru.Component.Ftp.Contracts;
2	using Kyameru.Component.Ftp.Settings;
3	using Kyameru.Core.Contracts;
4	using Kyameru.Core.Entities;
5	using System;
6	using System.Collections.Generic;
7	using System.Net;
8	using System.Text;
9	using System.Threading;
10	using System.Threading.Tasks;
11	using System.Timers;
12	using Kyameru.Core;
13	using Kyameru.Core.Sys;
14	using Timer = System.Timers.Timer;
15
16	namespace Kyameru.Component.Ftp
17	{
18	/// <summary>
19	/// FTP From Component
20	/// </summary>
21	/// <remarks>
22	/// Async not really implemented, needs more work and should really be using sftp.
23	/// </remarks>
24	public class From : IFtpFrom
25	{
26	private readonly FtpSettings ftpSettings;
27	private readonly IWebRequestUtility webRequestUtility;
28	private FtpClient ftp;
29	private Timer poller;
30
31	private bool _isStopping = false;	7✔
32
33	/// <summary>
34	/// Initializes a new instance of the <see cref="From"/> class.
35	/// </summary>
36	/// <param name="headers"></param>
37	public From(Dictionary<string, string> headers, IWebRequestUtility webRequestUtility)	7✔
38	{	7✔
39	ftpSettings = new FtpSettings(headers.ToFromConfig());	7✔
40	this.webRequestUtility = webRequestUtility;	7✔
41	}	7✔
42
UNCOV 43	public bool PollerIsActive => poller.Enabled;	×
44
45	public event AsyncEventHandler<RoutableEventData> OnActionAsync;
46
47	/// <summary>
48	/// Event raised when logging.
49	/// </summary>
50	public event EventHandler<Log> OnLog;
51
52	/// <summary>
53	/// Sets up the component.
54	/// </summary>
55	public void Setup()
56	{	6✔
57	ftp = new FtpClient(ftpSettings, webRequestUtility);	6✔
58	poller = new Timer(ftpSettings.PollTime);	6✔
59	poller.Elapsed += Poller_Elapsed;	6✔
60	poller.AutoReset = true;	6✔
61	ftp.OnDownloadFile += Ftp_OnDownloadFile;	6✔
62	ftp.OnLog += Ftp_OnLog;	6✔
63	ftp.OnError += Ftp_OnError;	6✔
64	webRequestUtility.OnLog += WebRequestUtility_OnLog;	6✔
65	}	6✔
66
67	/// <summary>
68	/// Event triggered when timer elapses.
69	/// </summary>
70	/// <param name="sender">Object sending the event.</param>
71	/// <param name="e">Elapsed arguments.</param>
72	private void Poller_Elapsed(object sender, ElapsedEventArgs e)
73	{	69✔
74	if (!_isStopping)	69✔
75	{	67✔
76	ftp.Poll();	67✔
77	}	67✔
78	else
79	{	2✔
80	poller.Stop();	2✔
81	}	2✔
82	}	69✔
83
84	/// <summary>
85	/// Logs an error event.
86	/// </summary>
87	/// <param name="sender">Object sending the event.</param>
88	/// <param name="e">Exception being raised.</param>
89	private void Ftp_OnError(object sender, Exception e)
90	{	70✔
91	OnLog?.Invoke(this, new Log(Microsoft.Extensions.Logging.LogLevel.Error, Resources.ERROR_FTPPROCESSING, e));	70!
92	}	70✔
93
94	/// <summary>
95	/// Event raised when logging.
96	/// </summary>
97	/// <param name="sender">Object sending</param>
98	/// <param name="e">Event message.</param>
99	private void Ftp_OnLog(object sender, string e)
100	{	3✔
101	OnLog?.Invoke(this, new Log(Microsoft.Extensions.Logging.LogLevel.Information, e));	3✔
102	}	3✔
103
104	/// <summary>
105	/// Event raised when file is downloaded.
106	/// </summary>
107	/// <param name="sender">Object sending the event.</param>
108	/// <param name="e">Message to route.</param>
109	private void Ftp_OnDownloadFile(object sender, Routable e)
110	{	3✔
111	OnActionAsync?.Invoke(this, new RoutableEventData(e, new CancellationToken()));	3✔
112	}	3✔
113
114	public async Task StartAsync(CancellationToken cancellationToken)
115	{	5✔
116	if (!cancellationToken.IsCancellationRequested)	5✔
117	{	5✔
118	ftp.Poll();	5✔
119	poller.Start();	5✔
120	}	5✔
121
122	await Task.CompletedTask;	5✔
123	}	5✔
124
125	public async Task StopAsync(CancellationToken cancellationToken)
126	{	4✔
127	_isStopping = true;	4✔
128	poller.AutoReset = false;	4✔
129	poller.Stop();	4✔
130	poller.Enabled = false;	4✔
131	await Task.CompletedTask;	4✔
132	}	4✔
133
134	private void WebRequestUtility_OnLog(object sender, string e)
135	{	1✔
136	OnLog?.Invoke(this, new Log(Microsoft.Extensions.Logging.LogLevel.Information, e));	1!
137	}	1✔
138	}
139	}

djsuperchief / Kyameru / 15063454499

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous