gregswindle / frisky_sleuth Goto Github PK

Feature request

As a Gitlab administrator or repo Maintainer,
I want to export extension, filename, and path Signature to YAML
In order to identify risky push events with a pre-receive hook.

Notes

Need a class like this:

"""
frisky_sleuth.export.to.gitlab.files_blacklist
"""

class FilesBlacklist():

  """
  Constructor
  """

  def __init__(self, signatures):
     self.signatures = signatures
     self.entries = self.from_signatures(self.signatures)

  """
  Convert signatures to YAML comments and list entries.
  """

  def from_signatures(self, signatures):
    entries = []
    for signature in signatures:
      entry = f"# Detect {signature.caption.lower()}s\n# by {signature.part} {signature.type}."
      if signature.description:
        entry = text + f"\n\n# @description\n# {signature.description}"
      entry + f"\n\n- {signature.pattern}\n\n"
      entries.append(entry)
    return entries

  """
  Generate valid YAML strings.
  """

  def __str__(self):
    return self.entries.join('\n\n')

1. User story summary

As a consumer and contributor,
I want frisky refactored into modules
In order to extend the library and reuse its codebase.

2. Acceptance criteria

We'll be done when:

• 1. frisky's features are extracted into modules.
• 2. We can recursively inspect all files within a directory.
• 3. The frisky_sleuth package returns the same results as frisky.

3. Notes

Is your feature request related to a problem? Please describe.

frisky is difficult to unit test. Breaking features into modules makes testing possible.

Describe the solution you'd like

• A package for API consumption
• A CLI "wrapper" (i.e., Terminal controller) that inspects a local repository (just like frisky currently does).

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.