1
|
|
|
"""Wrappers for the dependency configuration files.""" |
2
|
|
|
|
3
|
1 |
|
import os |
4
|
1 |
|
import logging |
5
|
1 |
|
import warnings |
6
|
|
|
|
7
|
1 |
|
import yorm |
|
|
|
|
8
|
1 |
|
from yorm.types import String, AttributeDictionary |
|
|
|
|
9
|
|
|
|
10
|
1 |
|
from .. import common |
11
|
1 |
|
from .. import git |
12
|
1 |
|
from .. import shell |
13
|
1 |
|
from ..exceptions import InvalidConfig, InvalidRepository, UncommittedChanges |
14
|
|
|
|
15
|
|
|
|
16
|
1 |
|
log = logging.getLogger(__name__) |
|
|
|
|
17
|
|
|
|
18
|
|
|
|
19
|
1 |
|
@yorm.attr(name=String) |
20
|
1 |
|
@yorm.attr(link=String) |
21
|
1 |
|
@yorm.attr(repo=String) |
22
|
1 |
|
@yorm.attr(rev=String) |
23
|
1 |
|
class Source(AttributeDictionary): |
24
|
|
|
"""A dictionary of `git` and `ln` arguments.""" |
25
|
|
|
|
26
|
1 |
|
DIRTY = '<dirty>' |
27
|
1 |
|
UNKNOWN = '<unknown>' |
28
|
|
|
|
29
|
1 |
|
def __init__(self, repo, name, rev='master', link=None): |
30
|
1 |
|
super().__init__() |
31
|
1 |
|
self.repo = repo |
32
|
1 |
|
self.name = name |
33
|
1 |
|
self.rev = rev |
34
|
1 |
|
self.link = link |
35
|
1 |
|
if not self.repo: |
36
|
1 |
|
raise InvalidConfig("'repo' missing on {}".format(repr(self))) |
37
|
1 |
|
if not self.name: |
38
|
1 |
|
raise InvalidConfig("'name' missing on {}".format(repr(self))) |
39
|
|
|
|
40
|
1 |
|
def __repr__(self): |
41
|
1 |
|
return "<source {}>".format(self) |
42
|
|
|
|
43
|
1 |
|
def __str__(self): |
44
|
1 |
|
pattern = "'{r}' @ '{v}' in '{d}'" |
45
|
1 |
|
if self.link: |
46
|
1 |
|
pattern += " <- '{s}'" |
47
|
1 |
|
return pattern.format(r=self.repo, v=self.rev, d=self.name, s=self.link) |
48
|
|
|
|
49
|
1 |
|
def __eq__(self, other): |
50
|
1 |
|
return self.name == other.name |
51
|
|
|
|
52
|
1 |
|
def __ne__(self, other): |
53
|
1 |
|
return self.name != other.name |
54
|
|
|
|
55
|
1 |
|
def __lt__(self, other): |
56
|
1 |
|
return self.name < other.name |
57
|
|
|
|
58
|
1 |
|
def update_files(self, force=False, fetch=False, clean=True): |
59
|
|
|
"""Ensure the source matches the specified revision.""" |
60
|
1 |
|
log.info("Updating source files...") |
61
|
|
|
|
62
|
|
|
# Clone the repository if needed |
63
|
1 |
|
if not os.path.exists(self.name): |
64
|
1 |
|
git.clone(self.repo, self.name) |
65
|
|
|
|
66
|
|
|
# Enter the working tree |
67
|
1 |
|
shell.cd(self.name) |
68
|
1 |
|
if not git.valid(): |
69
|
1 |
|
raise self._invalid_repository |
70
|
|
|
|
71
|
|
|
# Check for uncommitted changes |
72
|
1 |
|
if not force: |
73
|
1 |
|
log.debug("Confirming there are no uncommitted changes...") |
74
|
1 |
|
if git.changes(include_untracked=clean): |
75
|
|
|
common.show() |
76
|
|
|
msg = "Uncommitted changes in {}".format(os.getcwd()) |
77
|
|
|
raise UncommittedChanges(msg) |
78
|
|
|
|
79
|
|
|
# Fetch the desired revision |
80
|
1 |
|
if fetch or self.rev not in (git.get_branch(), |
81
|
|
|
git.get_hash(), |
82
|
|
|
git.get_tag()): |
83
|
1 |
|
git.fetch(self.repo, self.rev) |
84
|
|
|
|
85
|
|
|
# Update the working tree to the desired revision |
86
|
1 |
|
git.update(self.rev, fetch=fetch, clean=clean) |
87
|
|
|
|
88
|
1 |
|
def create_link(self, root, force=False): |
89
|
|
|
"""Create a link from the target name to the current directory.""" |
90
|
1 |
|
if not self.link: |
91
|
1 |
|
return |
92
|
|
|
|
93
|
1 |
|
log.info("Creating a symbolic link...") |
94
|
|
|
|
95
|
1 |
|
if os.name == 'nt': |
96
|
|
|
warnings.warn("Symbolic links are not supported on Windows") |
97
|
|
|
return |
98
|
|
|
|
99
|
1 |
|
target = os.path.join(root, self.link) |
100
|
1 |
|
source = os.path.relpath(os.getcwd(), os.path.dirname(target)) |
101
|
|
|
|
102
|
1 |
|
if os.path.islink(target): |
103
|
1 |
|
os.remove(target) |
104
|
1 |
|
elif os.path.exists(target): |
105
|
1 |
|
if force: |
106
|
1 |
|
shell.rm(target) |
107
|
|
|
else: |
108
|
1 |
|
common.show() |
109
|
1 |
|
msg = "Preexisting link location at {}".format(target) |
110
|
1 |
|
raise UncommittedChanges(msg) |
111
|
|
|
|
112
|
1 |
|
shell.ln(source, target) |
113
|
|
|
|
114
|
1 |
|
def identify(self, allow_dirty=True, allow_missing=True): |
115
|
|
|
"""Get the path and current repository URL and hash.""" |
116
|
1 |
|
if os.path.isdir(self.name): |
117
|
|
|
|
118
|
1 |
|
shell.cd(self.name) |
119
|
1 |
|
if not git.valid(): |
120
|
1 |
|
raise self._invalid_repository |
121
|
|
|
|
122
|
1 |
|
path = os.getcwd() |
123
|
1 |
|
url = git.get_url() |
124
|
1 |
|
if git.changes(display_status=not allow_dirty, _show=True): |
125
|
1 |
|
if not allow_dirty: |
126
|
1 |
|
common.show() |
127
|
1 |
|
msg = "Uncommitted changes in {}".format(os.getcwd()) |
128
|
1 |
|
raise UncommittedChanges(msg) |
129
|
|
|
|
130
|
|
|
common.show(self.DIRTY, color='dirty', log=False) |
131
|
|
|
return path, url, self.DIRTY |
132
|
|
|
else: |
133
|
1 |
|
revision = git.get_hash(_show=True) |
134
|
1 |
|
common.show(revision, color='revision', log=False) |
135
|
1 |
|
return path, url, revision |
136
|
|
|
|
137
|
1 |
|
elif allow_missing: |
138
|
|
|
|
139
|
1 |
|
return os.getcwd(), '<missing>', self.UNKNOWN |
140
|
|
|
|
141
|
|
|
else: |
142
|
|
|
|
143
|
1 |
|
raise self._invalid_repository |
144
|
|
|
|
145
|
1 |
|
def lock(self): |
146
|
|
|
"""Return a locked version of the current source.""" |
147
|
1 |
|
_, _, revision = self.identify(allow_dirty=False, allow_missing=False) |
148
|
1 |
|
source = self.__class__(self.repo, self.name, revision, self.link) |
149
|
1 |
|
return source |
150
|
|
|
|
151
|
1 |
|
@property |
152
|
|
|
def _invalid_repository(self): |
|
|
|
|
153
|
1 |
|
path = os.path.join(os.getcwd(), self.name) |
154
|
1 |
|
msg = "Not a valid repository: {}".format(path) |
155
|
|
|
return InvalidRepository(msg) |
156
|
|
|
|
This can be caused by one of the following:
1. Missing Dependencies
This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands.
2. Missing __init__.py files
This error could also result from missing
__init__.py
files in your module folders. Make sure that you place one file in each sub-folder.