1176057784

Build Type

github

Committed by GitHub

Commit Message

Merge 39e87ffa7 into 22ccab80f

Pull Request Pull Request #40: Add campaign summary export

Run Details

94 of 392 branches covered (23.98%)

Branch coverage included in aggregate %.

15 of 77 new or added lines in 3 files covered. (19.48%)

234 existing lines in 8 files now uncovered.

292 of 1266 relevant lines covered (23.06%)

0.92 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/templates/generate_template.py

"""Generate templates for import into an assessment JSON with the PCA Wizard.

Usage:
  pca-wizard-templates (--emails | --targets)
  pca-wizard-templates (-h | --help)
  pca-wizard-templates --version
Options:
  -e --emails   Output a JSON template file for phishing emails.
  -t --targets  Output a CSV template file for phishing targets.
  -h --help     Show this screen.
  --version     Show version.
"""

# Standard Python Libraries
import json
from typing import Dict

# Third-Party Libraries
from docopt import docopt

from ._version import __version__

EMAIL_TEMPLATE = {
    "id": "Database ID",
    "from_address": "John Doe <john.doe@domain.tld>",
    "subject": "Subject",
    "html": '<div><div id="body"><p> </p></div></div>',
    "text": "",
}

TARGET_TEMPLATE = "First Name,Last Name,Email,Position"


def email_output():
    """Output an email JSON template."""
    print('Saving "template_emails.json"...')
    with open("template_email.json", "w") as fp:
        json.dump(EMAIL_TEMPLATE, fp, indent=4)


def targets_output():
    """Output a target emails CSV."""
    print('Saving "template_targets.csv"...')
    with open("template_targets.csv", "w") as fp:
        fp.write(TARGET_TEMPLATE)


def main() -> None:
    """Execute either email_output() or targets_output()."""
    args: Dict[str, str] = docopt(__doc__, version=__version__)

    if args["--emails"]:
        email_output()
    elif args["--targets"]:
        targets_output()

1	"""Generate templates for import into an assessment JSON with the PCA Wizard.
2
3	Usage:
4	pca-wizard-templates (--emails \| --targets)
5	pca-wizard-templates (-h \| --help)
6	pca-wizard-templates --version
7	Options:
8	-e --emails Output a JSON template file for phishing emails.
9	-t --targets Output a CSV template file for phishing targets.
10	-h --help Show this screen.
11	--version Show version.
12	"""
13
14	# Standard Python Libraries
UNCOV 15	import json	×
UNCOV 16	from typing import Dict	×
17
18	# Third-Party Libraries
UNCOV 19	from docopt import docopt	×
20
21	from ._version import __version__	×
22
23	EMAIL_TEMPLATE = {	×
24	"id": "Database ID",
25	"from_address": "John Doe <john.doe@domain.tld>",
26	"subject": "Subject",
27	"html": '<div><div id="body"><p> </p></div></div>',
28	"text": "",
29	}
30
UNCOV 31	TARGET_TEMPLATE = "First Name,Last Name,Email,Position"	×
32
33
UNCOV 34	def email_output():	×
35	"""Output an email JSON template."""
36	print('Saving "template_emails.json"...')	×
UNCOV 37	with open("template_email.json", "w") as fp:	×
38	json.dump(EMAIL_TEMPLATE, fp, indent=4)	×
39
40
UNCOV 41	def targets_output():	×
42	"""Output a target emails CSV."""
43	print('Saving "template_targets.csv"...')	×
UNCOV 44	with open("template_targets.csv", "w") as fp:	×
45	fp.write(TARGET_TEMPLATE)	×
46
47
UNCOV 48	def main() -> None:	×
49	"""Execute either email_output() or targets_output()."""
50	args: Dict[str, str] = docopt(__doc__, version=__version__)	×
51
52	if args["--emails"]:	×
UNCOV 53	email_output()	×
54	elif args["--targets"]:	×
55	targets_output()	×

cisagov / gophish-tools / 1176057784

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous