BHoM_Adapter: allow push multiple Types at the same time by gathering dependency order

[alelom]

Depends on

BHoM/BHoM_Engine#2974

Issues addressed by this PR

Closes #331

Test files

Use the full testing procedure for Adapters on this PR.

Additional tests are temporarily provided in the form of Unit Test within the solution.
I found it extremely useful to develop this functionality by preparing tests before developing, because I could run the whole adapter workflow, debug and live-edit while debugging. I wish we could keep them where they are but, because currently this is non-compliant, they will likely be moved out in a dedicated toolkit, similarly to what we do with DiffingTests_prototypes.

Changelog

Additional comments

Because this feature is needed to fully leverage the work done by @EnricoAntolini in the Karamba_Toolkit, I am putting it as a high priority feature, to be merged as soon as possible. However, in depth testing is needed on this one.

Additionally, some ancillary features are needed to avoid some slowdown introduced by this PR, like #329, which should be mergeable soon after this gets merged.

[al-fisher]

Nice!
Quick comment on the Unit Tests - think good case to be made to keep closer to code for advanced framework projects like this!
The core framework code (which demands necessarily more complex functionality - and I would include in this the Adaptor and UI repos, and perhaps core functionality like versioning and serialisation etc.) should naturally have robust unit tests - and should be stored where most logical to ease development, testing and review.
This is perhaps converse to our “discipline engines” which we should continue to strive to be kept as “simple as possible”, relying heavily on our data set driven unit tests and for which the compliance rules were largely originally derived I feel.

Worth opening a discussion on refining compliance for the advanced cases like this @alelom to enanle gathering thoughts and consensus ?

[FraserGreenroyd]

See comments in the files changed for specific parts.

Regarding the testing - we already have a very nice framework set up using the .ci/code folder that we use for the tests such as versioning, serialisation, and null-handling. From what I can see in that the tests are doing within BHoM_Adapter_Tests here, all of that could be placed within the same framework quite happily, with a Verify method which can then be incorporated into the bot, which would allow us to then perform the tests on sub-toolkit adapters in addition to protecting the framework of the core adapter 😄

[FraserGreenroyd]

Have discussed with @alelom that he will put the adapter tests within the .ci folder for this repo, as a .ci/code solution called Verification.sln, which contains a Verify class (static class) in line with Versioning, Null-Handling, and Serialisation.

In addition to this, an additional project will be housed that contains @alelom console application that has allowed him to do the live-edit testing/debugging that has helped this work be developed up. This will allow us to have the best of the automated testing via the bot and during development testing 😄

[IsakNaslundBh]

small comment

[IsakNaslundBh]

Generally happy with the functionality now. From my testing on a couple of adapters it is working great.

Also, generally happy with the code, see minor comments above regarding the latest commits.

[IsakNaslundBh]

@BHoMBot check compliance

[bhombot-ci]

@IsakNaslundBh to confirm, the following actions are now queued:

• check code-compliance
• check documentation-compliance
• check project-compliance
• check branch-compliance
• check dataset-compliance
• check copyright-compliance

There are 31 requests in the queue ahead of you.

[FraserGreenroyd]

@BHoMBot check compliance

[bhombot-ci]

@FraserGreenroyd to confirm, the following actions are now queued:

• check code-compliance
• check documentation-compliance
• check project-compliance
• check branch-compliance
• check dataset-compliance
• check copyright-compliance

There are 4 requests in the queue ahead of you.

[alelom]

@BHoMBot check required

[bhombot-ci]

@alelom to confirm, the following actions are now queued:

• check code-compliance
• check documentation-compliance
• check project-compliance
• check core
• check null-handling
• check serialisation
• check versioning
• check installer

[bhombot-ci]

Please be advised that the check with reference 10440275415 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 286 additional annotations waiting, made up of 286 errors and 0 warnings.

[alelom]

@BHoMBot check required

[bhombot-ci]

@alelom to confirm, the following actions are now queued:

• check code-compliance
• check documentation-compliance
• check project-compliance
• check core
• check null-handling
• check serialisation
• check versioning
• check installer

[alelom]

@BHoMBot check project-compliance

[bhombot-ci]

@alelom to confirm, the following actions are now queued:

• check project-compliance

[alelom]

@BHoMBot check project-compliance

[IsakNaslundBh]

@BHoMBot check compliance
@BHoMBot check required

[bhombot-ci]

@IsakNaslundBh to confirm, the following actions are now queued:

• check code-compliance
• check documentation-compliance
• check project-compliance
• check branch-compliance
• check dataset-compliance
• check copyright-compliance
• check code-compliance
• check documentation-compliance
• check project-compliance
• check core
• check null-handling
• check serialisation
• check versioning
• check installer

[bhombot-ci]

The check code-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

[bhombot-ci]

The check documentation-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

[IsakNaslundBh]

re-approving after updating copyright-year

[FraserGreenroyd]

@BHoMBot check ready-to-merge

[bhombot-ci]

@FraserGreenroyd to confirm, the following actions are now queued:

• check ready-to-merge

There are 9 requests in the queue ahead of you.

[bhombot-ci]

FAO: @FraserGreenroyd
@IsakNaslundBh is seeking dispensation on this Pull Request to skip a required check. Please can you provide authorisation for the check to be skipped, or provide assistance as appropriate.

The check they wish to have dispensation on is project-compliance.

If you are providing dispensation on this occasion, please reply with:

@BHoMBot this is a DevOps instruction. I am authorising dispensation to be granted on check ref. 10483867458

[IsakNaslundBh]

@BHoMBot this is a DevOps instruction. I am authorising dispensation to be granted on check ref. 10483867458

[bhombot-ci]

@IsakNaslundBh I have now provided a passing check on reference 10483867458 as requested.

Comments made have been adressed. Dismissing

[IsakNaslundBh]

Autorising the ProjectCOmpliance on the basis that only the .ci folder is affected, as agreed in comment from @FraserGreenroyd above

[IsakNaslundBh]

@BHoMBot check ready-to-merge

[bhombot-ci]

@IsakNaslundBh to confirm, the following actions are now queued:

• check ready-to-merge