Added the ability to output a binary log from MSBuild.

[luckielordie]

This is a change that adds the MSBuild binary logging ability referenced by the issue #3625
Closes #3625

Changelog: Feature: Added parameter to the build() method of the MSBuild() build helper to create a binary log.

[jgsogo]

Hi! Thanks for taking this into account.

I would consider passing the output filename (https://github.com/Microsoft/msbuild/blob/master/documentation/wiki/Binary-Log.md#creating-a-binary-log-during-a-build) in the param output_binary_log, not very fan of this semantics, but something like this can work:

• if not output_binary_log, then do not add the /bl argument.
• if ouptut_binary_log and isinstance(output_binary_log, bool), then add just /bl
• if output_binary_log, then add "/bl:{}".format(output_binary_log)

Also, it should be conditionally added to MSBuild >=15.3, whick is the first version to support it.

[luckielordie]

Hi! Thanks for taking this into account.

I would consider passing the output filename (https://github.com/Microsoft/msbuild/blob/master/documentation/wiki/Binary-Log.md#creating-a-binary-log-during-a-build) in the param output_binary_log, not very fan of this semantics, but something like this can work:

• if not output_binary_log, then do not add the /bl argument.
• if ouptut_binary_log and isinstance(output_binary_log, bool), then add just /bl
• if output_binary_log, then add "/bl:{}".format(output_binary_log)

Also, it should be conditionally added to MSBuild >=15.3, whick is the first version to support it.

All good suggestions! I'll try to update this tonight.

[luckielordie]

Sorry, in haste I clicked the wrong button.

[luckielordie]

What sort of behaviour is appropriate if the version does not support the binary logging feature?

It's not fatal but do we still want the build to be completed? Should we warn and carry on or warn and fail?

Is there a mechanism in place already to get the msbuild version we're currently using?

[CLAassistant]

All committers have signed the CLA.

[jgsogo]

What sort of behaviour is appropriate if the version does not support the binary logging feature?
It's not fatal but do we still want the build to be completed? Should we warn and carry on or warn and fail?

I'm not sure. I think that this feature won't be enabled by default in a recipe, so you are going to use it when you are working on a recipe: you will activate it explicitly, look for that file, and use it for debugging. If this is the use case, I will raise.

Is there a mechanism in place already to get the msbuild version we're currently using?

Other tools like CMake or SVN are adding an staticmethod called get_version to get this kind of information, you will need to create your own. Maybe in the future we need to unify them all, but until now there is no work in that direction.

conan/conans/client/build/cmake.py

Line 329 in acd821c

@staticmethod

[jgsogo]

@luckielordie, we need some changes in this PR to make it pass the test-suite.

And also, we need Matthew Lord to sign the CLA... can you tell him? it looks like he has no github account 😕

[luckielordie]

@luckielordie, we need some changes in this PR to make it pass the test-suite.

And also, we need Matthew Lord to sign the CLA... can you tell him? it looks like he has no github account

That's me, my work email isn't attatched to my github, didn't realise at the time.

I keep meaning to come around and fix this whenever I have time.

[jgsogo]

Just a kindly reminder... 😇

[danimtb]

Hi @luckielordie 👋

We are willing to include this PR on the next Conan release. We could work over this same PR if you don't have time, but we need you to sign the CL to add the changes. Please update us and we will proceed accordingly.

Thanks! 😄

[luckielordie]

Hi @luckielordie

We are willing to include this PR on the next Conan release. We could work over this same PR if you don't have time, but we need you to sign the CL to add the changes. Please update us and we will proceed accordingly.

Thanks!

Sorry, let me sort this out on my lunch break. I'll get the CL signed and you're more than welcome to help me on it, I'm so short on time lately.

[danimtb]

We will need a test checking that the log is actually generated with the desired name

[jgsogo]

But LGTM

Review changes