Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Validate ConanFileReference only if requested #3623

Merged
merged 15 commits into from
Sep 27, 2018
Merged

Validate ConanFileReference only if requested #3623

Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
3c3b6e8
check that parameters are string before applying regex match
jgsogo Aug 28, 2018
161e1f2
add tests related to ConanName
jgsogo Aug 28, 2018
f3d6f33
typo
jgsogo Aug 28, 2018
8133446
update docs related to function
jgsogo Aug 28, 2018
9f48b5d
use six to check for string types
jgsogo Aug 28, 2018
c933ec0
use a custom message to validate each field
jgsogo Aug 29, 2018
46df758
refactor tests to validate custom messages
jgsogo Aug 29, 2018
d16c6da
fix tests: message is more explicit
jgsogo Aug 29, 2018
62f771e
Merge branch 'develop' into issue/3204
jgsogo Sep 4, 2018
7dc4321
given #3464 this is dead code
jgsogo Sep 4, 2018
672b460
format error message only if we are actually going to use it
jgsogo Sep 5, 2018
98ad177
minor changes: address @lasote review
jgsogo Sep 6, 2018
6e36c2d
Merge branch 'issue/3204' into engineering/3509
jgsogo Sep 10, 2018
5de7121
optional validation of conanfile reference
jgsogo Sep 10, 2018
6d9e8b8
Merge branch 'develop' into engineering/3509
jgsogo Sep 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 22 additions & 14 deletions conans/model/ref.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,25 +61,29 @@ class ConanFileReference(namedtuple("ConanFileReference", "name version user cha
sep_pattern = re.compile("@|/|#")
revision = None

def __new__(cls, name, version, user, channel, revision=None):
def __new__(cls, name, version, user, channel, revision=None, validate=True):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should validate defaulted to False and only validate in the ConanFileReference loading points?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel safer if we keep the previous behavior (always validating), at least in this pull request. Afterward, we can force it to be explicit and decide at each point if validation is needed or not.

"""Simple name creation.
@param name: string containing the desired name
@param version: string containing the desired version
@param user: string containing the user name
@param channel: string containing the user channel
@param revision: string containing the revision (optional)
"""
ConanName.validate_name(name, reference_token="package name")
ConanName.validate_name(version, True, reference_token="package version")
ConanName.validate_name(user, reference_token="user name")
ConanName.validate_name(channel, reference_token="channel")
version = Version(version)
obj = super(cls, ConanFileReference).__new__(cls, name, version, user, channel)
if revision:
ConanName.validate_name(revision, reference_token="revision")
obj.revision = revision
if validate:
obj.validate()
return obj

def validate(self):
ConanName.validate_name(self.name, reference_token="package name")
ConanName.validate_name(self.version, True, reference_token="package version")
ConanName.validate_name(self.user, reference_token="user name")
ConanName.validate_name(self.channel, reference_token="channel")
if self.revision:
ConanName.validate_name(self.revision, reference_token="revision")

def __eq__(self, value):
if not value:
return False
Expand All @@ -93,7 +97,7 @@ def __hash__(self):
return hash((self.name, self.version, self.user, self.channel, self.revision))

@staticmethod
def loads(text):
def loads(text, validate=True):
""" Parses a text string to generate a ConanFileReference object
"""
text = ConanFileReference.whitespace_pattern.sub("", text)
Expand All @@ -106,8 +110,7 @@ def loads(text):
except ValueError:
raise ConanException("Wrong package recipe reference %s\nWrite something like "
"OpenCV/1.0.6@user/stable" % text)
obj = ConanFileReference(name, version, user, channel)
obj.revision = revision
obj = ConanFileReference(name, version, user, channel, revision, validate=validate)
return obj

def __repr__(self):
Expand All @@ -134,25 +137,30 @@ class PackageReference(namedtuple("PackageReference", "conan package_id")):
"""
revision = None

def __new__(cls, conan, package_id):
def __new__(cls, conan, package_id, validate=True):
revision = None
if "#" in package_id:
package_id, revision = package_id.rsplit("#", 1)
ConanName.validate_name(revision, reference_token="revision")
obj = super(cls, PackageReference).__new__(cls, conan, package_id)
obj.revision = revision
if validate:
obj.validate()
return obj

def validate(self):
if self.revision:
ConanName.validate_name(self.revision, reference_token="revision")

@staticmethod
def loads(text):
def loads(text, validate=True):
text = text.strip()
tmp = text.split(":")
try:
conan = ConanFileReference.loads(tmp[0].strip())
package_id = tmp[1].strip()
except IndexError:
raise ConanException("Wrong package reference %s" % text)
return PackageReference(conan, package_id)
return PackageReference(conan, package_id, validate=validate)

def __repr__(self):
return "%s:%s" % (self.conan, self.package_id)
Expand Down