Implemented vanilla pack #6

ahuca · 2023-12-28T21:29:18Z

close #5 .

- Added `IPlcProject`, `ITwincatProject`, and `IAutomationInterface` - Added `README` with a brief description

Refactor code to use the newly added generic deserializing method for less code duplications when deserializing project files.

…oject Updated all projects to .NET 8 for consistency.

- Including `PlcProjectBelongToSolution()` and `IsTwincatProjectFileExtension()` - Resolving the appsettings.json absolution path

It used to be under `TwinGet.AutomationInterface.Test` project.

- Fixed namespace for `PackCommandValidatorTests.cs` - Added docs to `Test.Utils`

Using `Directory.EnumerateFiles()` instead of `Directory.GetFiles()`

DTO classes need not be tested.

Added more logging information during packaging.

In `TwincatUtils.cs`.

When a solution is provided, we validate whether the file exists.

In `PackageService.PackFromProjectFileAsync()`.

- In case for IPackCommand is propagated, we don't really want any side-effects from changing the its members. - Also added some functions for safe execute in `Thread` to `PackageService.cs`. For instance, `SafeExecute` and `SafeExecuteAsync`.

- By separating some logics to `ProjectFileUtils` folder/namespace

`PackageService` now uses that instead of `Thread`

Added try-catch block for `PackFromProjectFileAsync` when saving PLC project as library so we can return gracefully.

With `LogWith` method for logging a `PackagingException` given an `ILogger`

The use of ThreadLocal with `AutomationInterface` is not good.

`IsManagedLibrary` extracted to a extension method in `PlcProjectMetadataExtensions`

- Renamed methods to match the strategy pattern - Removed `DoCustomValidation` as the parameters used to initialize a strategy should have been validated

Colho · 2024-01-11T16:05:08Z

common.ps1

Would it be possible to add a small comment at the start of file on what the file does? Starting to get crowded with .ps1 files

For which files do you mean? ps1 files?

Damn you're right GitHub review is quite confusing. Completely missed the small little common.ps1

src/TwinGet.Cli/Properties/launchSettings.json

By default it launches with only the root command.

Due to [CVE-2024-005](GHSA-68w7-72jg-6qpp).

Since Node.js 16 actions is being deprecated. See this [blog post](https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/).

src/TwinGet.Core/Packaging/OtherStrings.cs

src/TwinGet.TwincatInterface/Exceptions/CouldNotGetSystemManager.cs

src/TwinGet.TwincatInterface/Exceptions/CouldNotLookUpPlcProject.cs

src/TwinGet.TwincatInterface/Exceptions/InvalidProjectFileFormat.cs

Colho · 2024-02-18T20:36:09Z

There were a couple of Exceptions without the Exception suffix, decided its better to make a one comment about it rather than ping it on each file separately.

test/Test.Utils/CommandRunnerResult.cs

Colho · 2024-02-19T21:28:38Z

src/TwinGet.TwincatInterface/TwincatProject.cs

+        {
+#pragma warning disable CS8604 // Possible null reference argument.
+            plcProjects.AddRange(
+                from ProjectElement project in tcSmProject.Project.Plc.Projects


Feel like this could be LINQed somewhere in the future

ahuca added 30 commits December 16, 2023 21:50

refactor: Added interface usage to AutomationInterface

d7fd8df

- Added `IPlcProject`, `ITwincatProject`, and `IAutomationInterface` - Added `README` with a brief description

docs: Added documentation comments to some public-facing interfaces

245b7ca

refactor: Renamed AutomationInterfaceConstants to TwincatConstants

5a7d6c8

feat: Added GetParentTwincatProject

999defa

feat: Added XmlSerializer to TwinGet.Utils

ca7554b

Refactor code to use the newly added generic deserializing method for less code duplications when deserializing project files.

feat: Added GetParentSolutionFile to TwincatUtils.cs

a54ca84

build: Updated to .net 8 due to Microsoft.Build

e8c9ea3

chore: Added and reapplied TwinCAT3 .gitignore to test/

0d2aa66

build: Migrated DTO objects to a TwinGet.AutomationInterface.Dto pr…

308e53d

…oject Updated all projects to .NET 8 for consistency.

feat: Added skeleton pack command

d479d15

feat: Added several TwinCAT utils

35a9305

- Including `PlcProjectBelongToSolution()` and `IsTwincatProjectFileExtension()` - Resolving the appsettings.json absolution path

chore: Extracted test utilities to a separate project Test.Utils

b5148dd

It used to be under `TwinGet.AutomationInterface.Test` project.

build: Updated Microsoft.NET.Test.Sdk to latest stable

c357ee7

refactor: extracted TwinGet.AutomationInterface.Dto.Test project

9fe360b

- Fixed namespace for `PackCommandValidatorTests.cs` - Added docs to `Test.Utils`

build: Renamed AutomationInterface namespace to TwincatInterface

ce203c6

feat: Added partially implemented PackageService

aa4521b

feat: Added TryDeserializeXmlFileAsync() to XmlSerializer.cs

c59de25

feat: Added GetParentTwincatProjectFileAsync() to TwincatUtils.cs

cacb5b5

refactor: Prefered using EnumerateFiles() for lazy evaluation

f9eb89a

Using `Directory.EnumerateFiles()` instead of `Directory.GetFiles()`

test: Removed TwinGet.TwincatInterface.Dto.Test

740afe9

DTO classes need not be tested.

feat: Added GetParentSolutionFileAsync() to TwincatUtils.cs

4eae98c

feat: Implemented PackageService.PackAsync()

1b72ce9

refactor: Extracted some methods at PackageService.cs

02e5f86

Added more logging information during packaging.

fix: Added missing path comparison to PlcProjectBelongToSolution

cef43d4

In `TwincatUtils.cs`.

test: Added more tests to PackCommandValidatorTests

c9a8e71

test: Added more tests to PackageServiceTests

30288a6

refactor: Added validation for solution option

7230dba

When a solution is provided, we validate whether the file exists.

refactor: Remove the library file after we are done packing

9851251

In `PackageService.PackFromProjectFileAsync()`.

test: Added PackCommandHanderTests.cs

0be36f7

ahuca added 11 commits December 31, 2023 20:27

refactor: Reduced resposiblities for TwincatUtils

aee2d5d

- By separating some logics to `ProjectFileUtils` folder/namespace

refactor: Added StaTaskScheduler

f38d6ae

`PackageService` now uses that instead of `Thread`

refactor: Applied file-scoped namespace for all

5386e43

refactor: Fixed all warnings and some suggestions

a57bf80

Added try-catch block for `PackFromProjectFileAsync` when saving PLC project as library so we can return gracefully.

refactor: Added PackagingExceptionExtensions

0eccba6

With `LogWith` method for logging a `PackagingException` given an `ILogger`

refactor: Fixed PackageService.SavePlcLibraryAsync

c3aa0cc

The use of ThreadLocal with `AutomationInterface` is not good.

refactor: Added warning when solution is not provided

2109b9f

refactor: Improved IsManagedLibrary

aaa9ef9

`IsManagedLibrary` extracted to a extension method in `PlcProjectMetadataExtensions`

ci: Run test reporting step regardless of previous step result

7670b88

refactor: Added pack strategy

4989026

refactor: cleaned up PlcProjectPackStrategy

f89b4d4

- Renamed methods to match the strategy pattern - Removed `DoCustomValidation` as the parameters used to initialize a strategy should have been validated

ahuca changed the title ~~5 implement vanilla pack~~ Implemented vanilla pack Jan 7, 2024

Colho reviewed Jan 11, 2024

View reviewed changes

refactor: Fixed naming typo in Core

37b6732

Colho reviewed Feb 13, 2024

View reviewed changes

src/TwinGet.Cli/Properties/launchSettings.json Outdated Show resolved Hide resolved

ahuca added 5 commits February 14, 2024 16:18

chore: Removed unnecessary launch setting

82588ed

By default it launches with only the root command.

Merge branch 'main' into 5-implement-vanilla-pack

2703298

build: Bumped version for some NuGet packages

feb6d6e

Due to [CVE-2024-005](GHSA-68w7-72jg-6qpp).

refactor: Added settings for DTE instance on creation

90bf6fa

ci: Updated actions/checkout to v4

d66a262

Since Node.js 16 actions is being deprecated. See this [blog post](https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/).