introducing modern conan.tool.scm.Git helper #10594

memsharded · 2022-02-16T12:42:46Z

Changelog: Feature: Introduce new conan.tools.scm.Git helper, for direct use in export() method to capture git url and commit, and to be used in source() method to clone and checkout a git repo.
Docs: conan-io/docs#2419

This is a first iteration, containing only the capturing code that enables the old scm flow:

Very flat design, no inheritance, everything explicit.
Only the minimum methods to implement scm old flow
Powerful flexibility can implement the Git monorepo case

AFTER #10654

conans/test/utils/scm.py

conans/client/source.py

czoido · 2022-02-23T13:14:40Z

conan/tools/scm/git.py

+        status = self._run("status -s").strip()
+        return bool(status)
+
+    def get_url_commit(self, remote="origin", branch="master"):


I think we should change this default to main.
Also since git>2.28 there's the init.defaultBranch configuration option that we may check using git config --get init.defaultBranch

I don't like the name get_url_commit, it reads like get the URL of the commit and makes no sense.
About the remote and branch defaults, maybe we should make it positional (not defaulted)? I would avoid extra commands like the git config --get init.defaultBranch suggested, even more, if they depend on the git version.

Maybe we can avoid using the branch and just use the commit hash? Do we need the branch name?

Agree, need to find a better name.

In any case, the branch needs to be worked out. It shouldn't be necessary, and indeed is very problematic for user flows like branching, PRs, in which the branch will not be "main" or "master". So the commit should be looked for directly in the remote without a branch hint, I'll investigate if this is possible.

I have changed the name to get_url_and_commit() and removed the branch argument, now checking if the commit is in any branch. Added a test with an actual branch pushed, to see it still works.

Co-authored-by: Luis Martinez <lasote@gmail.com>

* first approach. Big changes in Conf * Fixing errors * Fixing more tests * Deleted useless iteration * All the tests passing * Testing * Added items method * fixed rebased * Keeping old functions for backward compatibility * backward compatibility * Keeping indentation * Ordering methods and improved legacy logic * Added fixme * Reverted breaking changes * Added more complete test * Added more access Conf tests * Added docstring * Splitted string asserts * Added get/pop functions * Breaking refactor. Trying new structure * fixing tests * Changing tests * Fixed tests * Fixed Python 2.x problems * Removed useless layer of types * Fixed py2 * Fixed errors and added cast param to apply function to convert any type * Added TODO * Improved docstring * Fixed error * Update conans/model/conf.py Co-authored-by: James <james@conan.io> * Update conans/model/conf.py Co-authored-by: James <james@conan.io> * Added check_type and removed cast * Changed main structure. Now simpler and more powerful * Explicit default * Fixed error * Simplified compile options * Changed all the legacy conf getitem built-ins * Fixed test * Fixed bad type * Added more tests * More tests * Fix test for Python2 * Added more tests. Fixed corner-cases * Added one cli test and improved boolean conf UX * Moved str conveersion * Added one more mechanism to other smart conversion. Added more tests * Removed useless OR Co-authored-by: James <james@conan.io>

* Added custom versions and descriptions for components * Changed property to component_version. Backported to legacy PkgConfig

* WIP: Test failing * output_folder absolute only when existing * Fix test windows

* use absolute path * Update conans/test/integration/environment/test_env.py Co-authored-by: James <james@conan.io> * fix tests * fix test * fix win * fix win Co-authored-by: James <james@conan.io>

Co-authored-by: James <james@conan.io>

memsharded · 2022-03-01T16:00:08Z

conan/tools/files/files.py

@@ -491,3 +493,20 @@ def collect_libs(conanfile, folder=None):
                    result.append(name)
    result.sort()
    return result
+
+
+def swap_child_folder(parent_folder, child_folder):


Name to be improved. Suggestions welcome.

Maybe a generic move_folder_contents(dst_folder, folder, clean_first=True) ?

I think maybe we can split the operation in two, one for removing all folders but the one we want and other for moving the folder... or move_folder_contents(dst_folder, folder, clean_first=True) is more explicit, I'm ok with that too, maybe clean_other instead of clean_first?

I am annotating it to NOT document, so we can think about file methods in a more broad perspective, this PR is focused on the Git integration for sources, this is a very minor detail, just to prove it is possible to implement the mono-repo approach

conans/test/utils/scm.py

introducing modern conan.tool.scm.Git helper

ae66be8

memsharded added this to the 1.46 milestone Feb 16, 2022

SSE4 reviewed Feb 16, 2022

View reviewed changes

conans/test/utils/scm.py Show resolved Hide resolved

memsharded added 10 commits February 16, 2022 23:43

skip Py2, change git config order

1bfa516

wip

d811e17

wip

ccca294

Merge branch 'develop' into feature/new_scm_git

04e356d

wip

9c0e46b

wip

6af4427

let conandata_update create conandata.yml if not exist

eeb123b

Merge branch 'fix/conandata_update_create' into feature/new_scm_git

db807ec

full SCM test

d77c1a6

adding monorepo case

679ec4b

memsharded commented Feb 21, 2022

View reviewed changes

conans/client/source.py Outdated Show resolved Hide resolved

memsharded added 2 commits February 21, 2022 01:27

fix test

683700a

fix test

9d3e456

memsharded mentioned this pull request Feb 21, 2022

exports are not sources, not copied if layout() #10625

Merged

memsharded added 4 commits February 22, 2022 15:57

Merge branch 'develop' into feature/new_scm_git

4a63607

fix tests

da035a3

fix test

ea8bd95

merge develop

42a7a00

memsharded assigned lasote Feb 22, 2022

memsharded requested a review from czoido February 22, 2022 17:59

memsharded added 2 commits February 23, 2022 10:15

add subfolder test

e6ba52a

Merge branch 'develop' into feature/new_scm_git

a4aa3a9

czoido reviewed Feb 23, 2022

View reviewed changes

memsharded and others added 4 commits February 24, 2022 12:51

proposing base_source_folder, and folders.root

a092439

Merge branch 'develop' into feature/base_source_folder

658e7c3

Merge branch 'develop' into feature/new_scm_git

29fb041

Update conans/model/layout.py

ff7e5e5

Co-authored-by: Luis Martinez <lasote@gmail.com>

franramirez688 and others added 15 commits February 28, 2022 19:15

[PkgConfigDeps] Added new property component_version (conan-io#10633)

b5cd928

* Added custom versions and descriptions for components * Changed property to component_version. Backported to legacy PkgConfig

package_folder available when "conan install" consumer (conan-io#10655)

6209836

* WIP: Test failing * output_folder absolute only when existing * Fix test windows

added a few conf checkers (conan-io#10656)

13e2a71

Use absolute paths in conanbuild.sh (conan-io#10653)

ad8af04

* use absolute path * Update conans/test/integration/environment/test_env.py Co-authored-by: James <james@conan.io> * fix tests * fix test * fix win * fix win Co-authored-by: James <james@conan.io>

Cleanup tmpdirs (conan-io#10663)

3543fcc

refactor toolchain (conan-io#10665)

64d5c1d

fix not finding the Premake executable (conan-io#10250)

604ba15

Co-authored-by: James <james@conan.io>

review

b6971ba

Merge branch 'develop' into feature/base_source_folder

827b39a

Merge branch 'develop' into feature/new_scm_git

c6e4317

wip

0aba37a

Merge branch 'feature/base_source_folder' into feature/new_scm_git

45741ba

simplified tests

2cf53db

Merge branch 'develop' into feature/new_scm_git

b710317

memsharded commented Mar 1, 2022

View reviewed changes

memsharded requested a review from czoido March 1, 2022 16:00

new branch test

cadb399

memsharded requested a review from lasote March 1, 2022 17:03

lasote approved these changes Mar 2, 2022

View reviewed changes

conans/test/utils/scm.py Outdated Show resolved Hide resolved

czoido approved these changes Mar 2, 2022

View reviewed changes

memsharded added 2 commits March 2, 2022 14:40

review

6dde3ca

fix test

18491a6

memsharded mentioned this pull request Mar 2, 2022

new git feature conan-io/docs#2419

Merged

memsharded merged commit 3c3a718 into conan-io:develop Mar 2, 2022

memsharded deleted the feature/new_scm_git branch March 2, 2022 19:09

memsharded mentioned this pull request Mar 23, 2022

[question] Support of percent-encoded passwords for tools.Git #10854

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

introducing modern conan.tool.scm.Git helper #10594

introducing modern conan.tool.scm.Git helper #10594

memsharded commented Feb 16, 2022 •

edited

Loading

czoido Feb 23, 2022 •

edited

Loading

lasote Feb 24, 2022

czoido Feb 24, 2022

memsharded Feb 24, 2022

memsharded Mar 1, 2022

memsharded Mar 1, 2022

lasote Mar 2, 2022

czoido Mar 2, 2022 •

edited

Loading

memsharded Mar 2, 2022

introducing modern conan.tool.scm.Git helper #10594

introducing modern conan.tool.scm.Git helper #10594

Conversation

memsharded commented Feb 16, 2022 • edited Loading

czoido Feb 23, 2022 • edited Loading

Choose a reason for hiding this comment

lasote Feb 24, 2022

Choose a reason for hiding this comment

czoido Feb 24, 2022

Choose a reason for hiding this comment

memsharded Feb 24, 2022

Choose a reason for hiding this comment

memsharded Mar 1, 2022

Choose a reason for hiding this comment

memsharded Mar 1, 2022

Choose a reason for hiding this comment

lasote Mar 2, 2022

Choose a reason for hiding this comment

czoido Mar 2, 2022 • edited Loading

Choose a reason for hiding this comment

memsharded Mar 2, 2022

Choose a reason for hiding this comment

memsharded commented Feb 16, 2022 •

edited

Loading

czoido Feb 23, 2022 •

edited

Loading

czoido Mar 2, 2022 •

edited

Loading