def test_build_docs_blob_contents(get_readme_doc_file, get_html): get_readme_doc_file.return_value.name = 'README.md' get_html.return_value = '<p>A detailed guide</p>' collection_loader = CollectionLoader( '/tmpdir', 'filename', cfg=SimpleNamespace(run_ansible_doc=True)) collection_loader.content_objs = [ schema.Content(name='my_module', content_type=ContentType.MODULE), schema.Content(name='my_role', content_type=ContentType.ROLE), ] res = collection_loader._build_docs_blob() assert attr.asdict(res) == { 'collection_readme': { 'name': 'README.md', 'html': '<p>A detailed guide</p>' }, 'documentation_files': [], 'contents': [ { 'content_name': 'my_module', 'content_type': 'module', 'doc_strings': {}, 'readme_file': None, 'readme_html': None, }, { 'content_name': 'my_role', 'content_type': 'role', 'doc_strings': {}, 'readme_file': None, 'readme_html': None, }, ], }
def test_build_contents_blob(): collection_loader = CollectionLoader('/tmpdir', 'filename') collection_loader.content_objs = [ schema.Content(name='my_module', content_type=ContentType.MODULE), schema.Content(name='my_role', content_type=ContentType.ROLE), ] res = collection_loader._build_contents_blob() assert [attr.asdict(item) for item in res] == [ {'content_type': 'module', 'description': None, 'name': 'my_module'}, {'content_type': 'role', 'description': None, 'name': 'my_role'} ]
def load(self): self._log_loading() doc_strings = self._get_plugin_doc_strings() return schema.Content( name=self.path_name, content_type=self.content_type, doc_strings=doc_strings, )
def load(self): self._log_loading() self.doc_strings = self._get_doc_strings() return schema.Content( name=self.name, content_type=self.content_type, doc_strings=self.doc_strings, )
def load(self): self._log_loading() doc_strings = self._get_plugin_doc_strings() if self.cfg.run_flake8: for line in self._run_flake8(self.rel_path): self.log.warning(line) return schema.Content( name=self.path_name, content_type=self.content_type, doc_strings=doc_strings, )
def load(self): self._log_loading() description = self._get_metadata_description() readme = self._get_readme() for line in self._lint_role(self.rel_path): self.log.warning(line) return schema.Content( name=self.path_name, content_type=self.content_type, description=description, readme_file=readme.name, readme_html=markup_utils.get_html(readme), )
def load(self): self._log_loading() for line in self._lint_role(self.rel_path): self.log.warning(line) self._get_readme() self._get_metadata_description() return schema.Content( name=self.name, content_type=self.content_type, description=self.description, readme_file=self.readme_file, readme_html=self.readme_html, )
def load(self): self._log_loading() description = self._get_metadata_description() readme = self._get_readme() if self.cfg.run_ansible_lint: self._lint_role(self.rel_path) return schema.Content( name=self.path_name, content_type=self.content_type, description=description, readme_file=readme.name, readme_html=markup_utils.get_html(readme), )