utils.cdk

  1#!/usr/bin/env python3
  2"""
  3cdk
  4
  5Common code useful for a CDK diff/deploy.
  6
  7Example Usage:
  8    from utils import cdk
  9    from utils.cdk import get_cdk_required_version
 10"""
 11
 12import subprocess
 13import os
 14from pathlib import Path
 15import re
 16import typing
 17import glob
 18import json
 19import yaml
 20
 21try:
 22    import loggy
 23except ImportError:
 24    from utils import loggy
 25try:
 26    from .common import subprocess_long as _long_run, ChDir as _chdir
 27except ImportError:
 28    from utils.common import subprocess_long as _long_run, ChDir as _chdir
 29
 30
 31
 32
 33def deploy(properties_env: str, lang: typing.Optional[str] = None, path: typing.Optional[str] = None) -> bool:
 34    """
 35    deploy()
 36
 37    Runs `cdk deploy` using the properties_env to locate the `properties.env.json` file
 38
 39    properties_env: String containing env name to locate the properties file
 40    lang: String representing the type of CDK code to deploy
 41    path: String (Optional) Will search for the cdk.json file recursively if this path is not set.
 42
 43    Returns: True/False
 44    """
 45
 46    _CDK_PATH = path if path is not None else os.path.dirname(glob.glob('**/cdk.json', recursive=True)[0])
 47    _PROPS_FILE = f"properties.{properties_env}.json"
 48    _CDK_DEPLOY_FILE = f"{os.getcwd()}/cdk.deploy.txt"
 49
 50    with _chdir(_CDK_PATH):
 51        env_file = Path(_PROPS_FILE).read_text()
 52        # env_data = json.load(env_file)
 53        loggy.info(f"cdk.deploy(): {env_file}")
 54
 55        if not install_cdk_requirements(cdk_lang=lang):
 56            loggy.info("cdk.deploy(): Failed to install cdk requirements. Check logs.")
 57            return False
 58
 59        my_env = os.environ.copy()
 60        my_env["ENVIRONMENT"] = properties_env
 61
 62        _process_output = _long_run(['cdk', 'deploy', '--require-approval', 'never', '--all'], env=my_env, check=False)
 63        loggy.info("----------------------------------")
 64        loggy.info(f"cdk.deploy(): CDK returned {str(_process_output.returncode)}")
 65
 66        with open(_CDK_DEPLOY_FILE, 'w') as file:
 67            if _process_output.stderr:
 68                file.write(_process_output.stderr)
 69
 70            if _process_output.stdout:
 71                file.write(_process_output.stdout)
 72
 73        if _process_output.returncode != 0:
 74            return False
 75
 76    return True
 77
 78
 79def diff(properties_env: str, lang: typing.Optional[str] = None, path: typing.Optional[str] = None) -> bool:
 80    """
 81    diff()
 82
 83    Runs `cdk diff` using the properties_env to locate the `properties.env.json` file
 84
 85    properties_env: String containing env name to locate the properties file
 86    lang: String representing the type of CDK code to deploy (python, ts, typescript)
 87    path: String (Optional) Will search for the cdk.json file recursively if this path is not set.
 88
 89    Returns: True/False
 90    """
 91
 92    _CDK_PATH = path if path is not None else os.path.dirname(glob.glob('**/cdk.json', recursive=True)[0])
 93    _PROPS_FILE = f"properties.{properties_env}.json"
 94    _CDK_DIFF_FILE = f"{os.getcwd()}/cdk.diff.txt"
 95
 96    _EXIT = True
 97    with _chdir(_CDK_PATH):
 98        env_file = Path(_PROPS_FILE).read_text()
 99        # env_data = json.load(env_file)
100        loggy.info(f"cdk.diff(): {env_file}")
101
102        if not install_cdk_requirements(cdk_lang=lang):
103            loggy.info("cdk.diff(): Failed to install cdk requirements. Check logs.")
104            return False
105
106        my_env = os.environ.copy()
107        my_env["ENVIRONMENT"] = properties_env
108
109        _process_output = _long_run(['cdk', 'diff', '--fail', '--verbose'], env=my_env, check=False)
110        loggy.info("----------------------------------")
111        loggy.info(f"cdk.diff(): CDK returned {str(_process_output.returncode)}")
112        # loggy.info("----------------------------------")
113        # loggy.info(f"cdk.diff(): CDK returned {str(_process_output.stderr)}")
114        # loggy.info("----------------------------------")
115        # loggy.info(f"cdk.diff(): CDK returned {str(_process_output.stdout)}")
116        # loggy.info("----------------------------------")
117
118        if _process_output.returncode != 0:
119            loggy.info("cdk.diff(): Testing for CDK Diff or Error.")
120
121            with open(_CDK_DIFF_FILE, 'w') as file:
122                file.write(_process_output.stderr)
123
124            if '[~]' in _process_output.stderr or '[+]' in _process_output.stderr or '[-]' in _process_output.stderr or '[=]' in _process_output.stderr:
125                loggy.info("cdk.diff(): CDK Diff found!")
126                _EXIT = True
127            else:
128                loggy.info("cdk.diff(): CDK ERROR!")
129                for stack in glob.glob('cdk.out/*.json'):
130                    loggy.info("----------------------------------")
131                    loggy.info("STACK: " + stack)
132                    _stack_yaml = yaml.dump(json.loads(Path(stack).read_text()))
133                    loggy.info(_stack_yaml)
134                _EXIT = False
135
136        else:
137            # if 'DEPLOY_OVERRIDE' in os.environ.keys():
138            #     print("cdkDiff.__main__(): No CDK diff! Overriding CDK_DIFF because DEPLOY_OVERRIDE")
139            #     _EXIT = 0
140            # else:
141            with open(_CDK_DIFF_FILE, 'w') as file:
142                file.write("NO CDK diff found. This could be an AMI SSM Param change. Deploy proceding.")
143
144            loggy.info("cdk.diff(): NO CDK diff found. This could be an AMI SSM Param change. Deploy proceding.")
145            _EXIT = True
146
147    return _EXIT
148 
149
150def diff_pretty(diff_file: str='cdk.diff.txt', output_file: str='cdk.diff.html', verbose: bool=False) -> bool:
151
152    _CDK_DIFF_FILE = diff_file
153    _CDK_HTML_OUTPUT_FILE = output_file
154    _VERBOSE = verbose
155
156    html_template = """
157<!DOCTYPE html>
158<html>
159  <head>
160    <meta charset="utf-8" />
161    <title>prettyplan</title>
162    <meta name="viewport" content="width=device-width, initial-scale=1" />
163    <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/diff2html/bundles/css/diff2html.min.css" />
164    <style>
165      body {
166        font-family: Arial, Helvetica, sans-serif;
167        text-rendering: optimizeLegibility;
168        background: #ecf7fe;
169        color: #000000c0;
170        font-size: 15px;
171        margin: 0;
172      }
173      @keyframes fade-in {
174        0% {
175          opacity: 0;
176        }
177        100% {
178          opacity: 1;
179        }
180      }
181      .stripe {
182        width: 100%;
183        height: 5px;
184        background: #5c4ce4;
185        animation-name: wipe-in;
186        animation-duration: 1s;
187      }
188      @keyframes wipe-in {
189        0% {
190          width: 0%;
191        }
192        100% {
193          width: 100%;
194        }
195      }
196      #release-notification {
197        background: #5c4ce4;
198        color: white;
199        font-weight: bold;
200        text-align: center;
201        overflow: hidden;
202        padding: 10px 0 15px 0;
203        height: 20px;
204        animation-name: notification-pop-in;
205        animation-duration: 2s;
206      }
207      #release-notification a {
208        color: white;
209      }
210      #release-notification.dismissed {
211        animation-name: notification-pop-out;
212        animation-duration: 0.5s;
213        height: 0;
214        padding: 0;
215      }
216      @keyframes notification-pop-in {
217        0% {
218          height: 0;
219          padding: 0;
220        }
221        50% {
222          height: 0;
223          padding: 0;
224        }
225      }
226      @keyframes notification-pop-out {
227        0% {
228          height: 20px;
229          padding: 10px 0 15px 0;
230        }
231        100% {
232          height: 0;
233          padding: 0;
234        }
235      }
236      #modal-container {
237        animation-name: fade-in;
238        animation-duration: 0.2s;
239      }
240      .modal-pane {
241        position: fixed;
242        top: 0;
243        left: 0;
244        width: 100%;
245        height: 100%;
246        background: #ffffffe6;
247        z-index: 10;
248      }
249      .modal-content {
250        position: fixed;
251        width: 60%;
252        height: 60%;
253        top: 50%;
254        left: 50%;
255        transform: translate(-50%, -50%);
256        background: #ffffff;
257        box-shadow: 0 2px 6px 0 hsla(0, 0%, 0%, 0.2);
258        z-index: 20;
259      }
260      .modal-close {
261        position: absolute;
262        right: 0;
263        padding: 10px;
264      }
265      .modal-close button.text-button {
266        color: #4526ac;
267        text-decoration: none;
268        font-weight: normal;
269      }
270      .release-notes {
271        max-width: 80%;
272        margin: 0 auto 0 auto;
273        overflow-y: auto;
274        max-height: 100%;
275      }
276      #branding {
277        float: right;
278        padding-top: 10px;
279        padding-right: 10px;
280        font-size: 10px;
281        color: #4526ac;
282        text-align: right;
283      }
284      #branding a {
285        color: #4526ac;
286      }
287      .container {
288        margin: 10px 10px 0 10px;
289        animation-name: fade-in;
290        animation-duration: 1s;
291      }
292      @media only screen and (min-width: 600px) {
293        .container {
294          max-width: 80%;
295          margin-left: auto;
296          margin-right: auto;
297        }
298      }
299      h1,
300      h2 {
301        text-align: center;
302        color: #4526ac;
303      }
304      #terraform-plan {
305        width: 100%;
306        min-height: 300px;
307        border: none;
308        box-shadow: 0 2px 6px 0 hsla(0, 0%, 0%, 0.2);
309        padding: 10px;
310        margin-bottom: 10px;
311        resize: none;
312        background: #ffffffe6;
313      }
314      button {
315        font-size: 18px;
316        background: #5c4ce4;
317        color: #fff;
318        box-shadow: 0 2px 6px 0 hsla(0, 0%, 0%, 0.2);
319        border: none;
320        border-radius: 2px;
321        min-width: 170px;
322        height: 40px;
323      }
324      button:hover {
325        background: #6567ea;
326        cursor: pointer;
327      }
328      button:active {
329        background: #5037ca;
330      }
331      button.text-button {
332        background: none;
333        box-shadow: none;
334        border-radius: 0;
335        width: auto;
336        height: auto;
337        text-decoration: underline;
338        font-size: inherit;
339        font-weight: inherit;
340        font-family: Arial, Helvetica, sans-serif;
341        color: inherit;
342        text-align: inherit;
343        padding: 0;
344      }
345      #parsing-error-message {
346        background-color: #ffffff;
347        padding: 10px;
348        color: #000000c0;
349        margin: 4px;
350        box-shadow: 0 2px 6px 0 hsla(0, 0%, 0%, 0.2);
351        font-weight: bold;
352        border-left: 2px solid red;
353        animation-name: error;
354        animation-duration: 1s;
355      }
356      @keyframes error {
357        0% {
358          background-color: red;
359        }
360        100% {
361          background-color: white;
362        }
363      }
364      .prettyplan ul {
365        padding-left: 0;
366        font-size: 13px;
367      }
368      .prettyplan li {
369        list-style: none;
370        background: #ffffffe6;
371        padding: 10px;
372        color: #000000c0;
373        margin: 4px;
374        box-shadow: 0 2px 6px 0 hsla(0, 0%, 0%, 0.2);
375      }
376      .prettyplan ul.warnings li {
377        border-left: 3px solid #757575;
378      }
379      .prettyplan ul.actions li.update {
380        border-left: 3px solid #ff8f00;
381      }
382      .prettyplan ul.actions li.create {
383        border-left: 3px solid #2e7d32;
384      }
385      .prettyplan ul.actions li.addition {
386        border-left: 3px solid #2e7d32;
387      }
388      .prettyplan ul.actions li.destroy {
389        border-left: 3px solid #b71c1c;
390      }
391      .prettyplan ul.actions li.removal {
392        border-left: 3px solid #b71c1c;
393      }
394      .prettyplan ul.actions li.recreate {
395        border-left: 3px solid #1565c0;
396      }
397      .prettyplan ul.actions li.read {
398        border-left: 3px solid #519bf0;
399      }
400      .badge {
401        display: inline-block;
402        text-transform: uppercase;
403        margin-right: 10px;
404        padding: 3px;
405        font-size: 12px;
406        font-weight: bold;
407      }
408      .warnings .badge {
409        color: #757575;
410      }
411      li.update .badge {
412        color: #ff8f00;
413      }
414      li.create .badge {
415        color: #2e7d32;
416      }
417      li.addition .badge {
418        color: #2e7d32;
419      }
420      li.destroy .badge {
421        color: #b71c1c;
422      }
423      li.removal .badge {
424        color: #b71c1c;
425      }
426      li.recreate .badge {
427        color: #1565c0;
428      }
429      li.read .badge {
430        color: #519bf0;
431      }
432      .id-segment:not(:last-child)::after {
433        content: ' > ';
434      }
435      .id-segment.name,
436      .id-segment.type {
437        font-weight: bold;
438      }
439      .change-count {
440        float: right;
441      }
442      .summary {
443        cursor: pointer;
444      }
445      .no-diff-changes-breakdown {
446        margin: 5px auto 0 auto;
447        padding: 5px;
448      }
449      .no-diff-changes-breakdown table {
450        width: 100%;
451        word-break: break-all;
452        font-size: 13px;
453      }
454      .no-diff-changes-breakdown table td {
455        padding: 10px;
456        width: 40%;
457      }
458      pre {
459        white-space: pre-wrap;
460        background: #f3f3f3;
461      }
462      .no-diff-changes-breakdown table td.property {
463        width: 20%;
464        text-align: right;
465        font-weight: bold;
466      }
467      .no-diff-changes-breakdown table tr:nth-child(even) {
468        background-color: #f5f5f5;
469      }
470      .forces-new-resource {
471        color: #b71c1c;
472      }
473      .collapsed,
474      .hidden {
475        display: none;
476      }
477      .actions button {
478        background: none;
479        border: none;
480        text-decoration: underline;
481        color: black;
482        box-shadow: none;
483        font-weight: bold;
484        font-size: 14px;
485      }
486      .d2h-icon {
487        display: none;
488      }
489    </style>
490  </head>
491  <body>
492    <div class="stripe"></div>
493    <div class="container">
494      <h1>prettyplan</h1>
495      <div id="parsing-error-message" class="hidden">
496        That doesn't look like a Terraform plan. Did you copy the entire output (without colouring) from the plan
497        command?
498      </div>
499      <div id="prettyplan" class="prettyplan">
500        <ul id="errors" class="errors"></ul>
501        <ul id="warnings" class="warnings"></ul>
502        <button class="expand-all" onclick="expandAll()">Expand all</button>
503        <button class="collapse-all hidden" onclick="collapseAll()">Collapse all</button>
504        <div id="stacks"></div>
505        <ul id="actions" class="actions"></ul>
506        <pre id="diff"></pre>
507      </div>
508    </div>
509    <script>
510      function accordion(element) {
511        const changes = element.parentElement.getElementsByClassName('changes');
512        for (var i = 0; i < changes.length; i++) {
513          toggleClass(changes[i], 'collapsed');
514        }
515      }
516      function toggleClass(element, className) {
517        if (!element.className.match(className)) {
518          element.className += ' ' + className;
519        } else {
520          element.className = element.className.replace(className, '');
521        }
522      }
523      function addClass(element, className) {
524        if (!element.className.match(className)) element.className += ' ' + className;
525      }
526      function removeClass(element, className) {
527        element.className = element.className.replace(className, '');
528      }
529      function expandAll() {
530        const sections = document.querySelectorAll('.changes.collapsed');
531        for (var i = 0; i < sections.length; i++) {
532          toggleClass(sections[i], 'collapsed');
533        }
534        toggleClass(document.querySelector('.expand-all'), 'hidden');
535        toggleClass(document.querySelector('.collapse-all'), 'hidden');
536      }
537      function collapseAll() {
538        const sections = document.querySelectorAll('.changes:not(.collapsed)');
539        for (var i = 0; i < sections.length; i++) {
540          toggleClass(sections[i], 'collapsed');
541        }
542        toggleClass(document.querySelector('.expand-all'), 'hidden');
543        toggleClass(document.querySelector('.collapse-all'), 'hidden');
544      }
545      function removeChildren(element) {
546        while (element.lastChild) {
547          element.removeChild(element.lastChild);
548        }
549      }
550      function createModalContainer() {
551        const modalElement = document.createElement('div');
552        modalElement.id = 'modal-container';
553        document.body.appendChild(modalElement);
554        return modalElement;
555      }
556      function closeModal() {
557        const modalElement = document.getElementById('modal-container');
558        document.body.removeChild(modalElement);
559      }
560    </script>
561  </body>
562</html>
563"""
564
565    if _VERBOSE:
566        loggy.info("diff_pretty()): BEGIN")
567
568    if not Path(_CDK_DIFF_FILE).exists():
569        loggy.info(f"diff_pretty(): ERROR. INPUT FILE ({_CDK_DIFF_FILE}) does NOT exist.")
570        return False
571
572    if _VERBOSE:
573        loggy.info(f"diff_pretty(): Reading input file: {_CDK_DIFF_FILE}")
574
575    cdk_out = Path(_CDK_DIFF_FILE).read_text()
576
577    if _VERBOSE:
578        loggy.info(f"diff_pretty(): {cdk_out}")
579
580    #
581    # Here, we split the stack output into an array based on `Stack xyz` lines
582    #
583    stacks = [f"Stack {e}" for e in cdk_out.split('Stack ') if e]
584
585    #
586    # This is a Hack to get rid of any warnings at the top of the output before
587    # we encounter our first `Stack xyz` line.
588    #
589    for idx, l in enumerate(stacks):
590        match = False
591        for hack_line in cdk_out.split('\n'):
592            if l.split('\n')[0] in hack_line:
593                match = True
594                break
595
596        if not match:
597            del stacks[idx]
598            continue
599
600    #
601    # Convert each `Stack xyz` line to our HTML format
602    #
603    for idx, l in enumerate(stacks):
604        new_line = []
605        diff_type = ""
606        divs_open = 0
607        ul_li_open = 0
608        for ndx, n in enumerate(l.split('\n')):
609            if _VERBOSE:
610                loggy.info(f"diff_pretty(): DEBUG: ({str(idx)})-({str(ndx)}) - {str(n)}")
611
612            if ndx == 0:
613                # new_line.append(f"<div class=\"stack\"><h2>{n}</h2><div class=\"raw-diff\"><button onclick=\"accordion(this)\">Expand this Stack</button><div class=\"changes\">")
614
615                #
616                # 2 open divs
617                #
618                divs_open += 2
619                new_line.append(f"<div class=\"stack\"><h2>{n}</h2><button onclick=\"accordion(this)\">Expand this Stack</button><div class=\"changes\">")
620            else:
621                if n.startswith('IAM Policy Changes'):
622                    diff_type = "IAM"
623                elif n.startswith('Resources'):
624                    diff_type = "Resources"
625                elif n.startswith('Outputs'):
626                    diff_type = "Outputs"
627                elif n.startswith('There were no differences'):
628                    diff_type = "NoDiff"
629
630                if 'Resources' in diff_type or 'Outputs' in diff_type:
631                    if n.startswith('[+]'):
632                        if ul_li_open > 0:
633                            ul_li_open = 0
634                            divs_open -= 1
635                            new_line.append('<pre></div></li></ul>')
636
637                        ul_li_open += 1
638                        divs_open += 1
639                        new_line.append(f"<ul class=\"actions\"><li class=\"create\"><div class=\"summary\" onclick=\"accordion(this)\"><span class=\"badge\">Addition</span></div><div class\"changes\"><pre>{n}")
640                    elif n.startswith('[-]'):
641                        if ul_li_open > 0:
642                            ul_li_open = 0
643                            divs_open -= 1
644                            new_line.append('</pre></div></li></ul>')
645
646                        ul_li_open += 1
647                        divs_open += 1
648                        new_line.append(f"<ul class=\"actions\"><li class=\"destroy\"><div class=\"summary\" onclick=\"accordion(this)\"><span class=\"badge\">Delete</span></div><div class\"changes\"><pre>{n}")
649                    elif n.startswith('[~]'):
650                        if ul_li_open > 0:
651                            ul_li_open = 0
652                            divs_open -= 1
653                            new_line.append('</pre></div></li></ul>')
654
655                        ul_li_open += 1
656                        divs_open += 1
657                        if 'replace' in n or ((len(l)-1) >= ndx+1 and 'replace' in l[ndx+1]):
658                            new_line.append(f"<ul class=\"actions\"><li class=\"destroy\"><div class=\"summary\" onclick=\"accordion(this)\"><span class=\"badge\">REPLACEMENT</span></div><div class\"changes\"><pre>{n}")
659                        else:
660                            new_line.append(f"<ul class=\"actions\"><li class=\"update\"><div class=\"summary\" onclick=\"accordion(this)\"><span class=\"badge\">Update</span></div><div class\"changes\"><pre>{n}")
661
662                    else:
663                        new_line.append(f"{n}")
664
665                elif 'IAM' in diff_type:
666                    if divs_open <= 2:
667                        ul_li_open += 1
668                        divs_open += 1
669                        new_line.append(f"<ul class=\"actions\"><li class=\"update\"><div class=\"summary\" onclick=\"accordion(this)\"><span class=\"badge\">Update</span></div><div class\"changes\"><pre>{n}")
670                    else:
671                        new_line.append(f"{n}")
672
673                elif 'NoDiff' in diff_type:
674                    if divs_open <= 2:
675                        ul_li_open += 1
676                        divs_open += 1
677                        new_line.append(f"<ul class=\"actions\"><li class=\"read\"><div class=\"summary\" onclick=\"accordion(this)\"><span class=\"badge\">No Diff</span></div><div class\"changes\"><pre>{n}")
678                    else:
679                        new_line.append(f"{n}")
680
681        while ul_li_open > 0:
682            ul_li_open -= 1
683            divs_open -= 1
684            new_line.append('</pre></div></li></ul>')
685
686        while divs_open > 0:
687            divs_open -= 1
688            new_line.append('</div>')
689
690        stacks[idx] = '\n'.join(new_line)
691
692    #
693    # If there are no stacks, then we can print this as a giant error
694    #
695    if not stacks:
696        print("cdk-diff-pretty.__main__(): ERROR: No stacks found. Outputting diff as ERROR.")
697        stacks.append("<div class=\"stack\"><h2>CDK DIFF ERROR</h2><button onclick=\"accordion(this)\">Expand this Stack</button><div class=\"changes\">")
698        stacks.append("<ul class=\"actions\"><li class=\"destroy\"><div class=\"summary\" onclick=\"accordion(this)\"><span class=\"badge\">CDK DIFF ERROR</span></div><div class\"changes\"><pre>")
699        stacks.append(f"{cdk_out}")
700        stacks.append('</pre></div></li></ul>')
701        stacks.append('</div></div>')
702
703    html_template = html_template.replace('<h1>prettyplan</h1>', '<h1>CDK Diff</h1>')
704    html_template = html_template.replace('<title>prettyplan</title>', '<title>CDK Diff</title>')
705
706    html_template = html_template.replace('<div id="stacks"></div>', f"<div id=\"stacks\">{' '.join(stacks)}</div>")
707
708    if _VERBOSE:
709        loggy.info(f"diff_pretty(): Writing output file to {_CDK_HTML_OUTPUT_FILE}")
710
711    Path(_CDK_HTML_OUTPUT_FILE).write_text(html_template)
712    if _VERBOSE:
713        loggy.info("diff_pretty(): END")
714
715    return True
716
717
718def get_cdk_installed_version() -> str:
719    """
720    get_cdk_installed_version()
721
722    Get the CDK installed version.
723
724    Returns: String representing the installed version
725    """
726
727    loggy.info("cdk.get_cdk_installed_version(): BEGIN")
728    process_output = subprocess.run(['cdk', '--version'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=True)
729    loggy.info("cdk.get_cdk_installed_version(): BEGIN")
730    return process_output.stdout.decode().split(' ')[0]
731
732
733def get_cdk_required_version() -> str:
734    """
735    get_cdk_required_version()
736
737    Get the CDK required version. If `cdk_lock_version` file exists, pulls the
738    version value from there. Otherwise, returns the installed version of CDK.
739
740    Returns: String representing the required version
741    """
742    loggy.info("cdk.get_cdk_required_version(): BEGIN")
743    if os.path.exists('cdk_lock_version'):
744        _CDK_REQUIRED_VERSION = Path('cdk_lock_version').read_text().strip()
745    else:
746        _CDK_REQUIRED_VERSION = get_cdk_installed_version()
747
748    loggy.info("cdk.get_cdk_required_version(): END")
749    return _CDK_REQUIRED_VERSION
750
751
752def set_cdk_installed_version() -> str:
753    """
754    set_cdk_installed_version()
755
756    Set the CDK installed version. If the required version of CDK is different
757    from the installed version, run the npm commands to install the correct
758    version.
759
760    Returns: String representing the required version
761    """
762
763    loggy.info("cdk.set_cdk_installed_version(): BEGIN")
764    _CDK_REQUIRED_VERSION = get_cdk_required_version()
765    _CDK_INSTALLED_VERSION = get_cdk_installed_version()
766    loggy.info("cdk.set_cdk_installed_version(): _CDK_REQUIRED_VERSION: " + _CDK_REQUIRED_VERSION)
767    loggy.info("cdk.set_cdk_installed_version(): _CDK_INSTALLED_VERSION: " + _CDK_INSTALLED_VERSION)
768
769    if _CDK_REQUIRED_VERSION != _CDK_INSTALLED_VERSION:
770        subprocess.run(['sudo', 'npm', 'install', '-g', 'aws-cdk@' + _CDK_REQUIRED_VERSION], stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=True)
771
772    loggy.info("cdk.set_cdk_installed_version(): END")
773    return _CDK_REQUIRED_VERSION
774
775
776def install_cdk_requirements(cdk_lang: str) -> bool:
777    """
778    install_cdk_requirements()
779
780    Install requirements for the specific type/language of cdk deployment.
781
782    cdk_lang: String representing the type of CDK code to deploy
783
784    Returns: True/False
785    """
786    loggy.info("cdk.install_cdk_requirements(): BEGIN")
787    _cdk_required_version = set_cdk_installed_version()
788    if cdk_lang == 'python':
789        loggy.info("cdk.install_cdk_requirements(): Installing python requirements.")
790
791        if os.path.exists('setup.py'):
792            loggy.info("cdk.install_cdk_requirements(): Original setup.py file.")
793            _file_contents = Path('setup.py').read_text()
794            loggy.info(_file_contents)
795
796            #
797            # TAW 20220529 - Setting required version changes between cdk v1 and v2
798            #
799            if _cdk_required_version.startswith('1'):
800                loggy.info("cdk.install_cdk_requirements(): Detected cdk v1. Adding version number to aws_cdk.aws_*.")
801                _file_contents = re.sub('aws_cdk.aws_(.*)"', r'aws_cdk.aws_\1=='+_cdk_required_version+'"', _file_contents)
802            elif _cdk_required_version.startswith('2'):
803                loggy.info("cdk.install_cdk_requirements(): Detected cdk v2. Adding version number to aws-cdk-lib*.")
804                _file_contents = re.sub('aws-cdk-lib(.*)"', r'aws-cdk-lib\1=='+_cdk_required_version+'"', _file_contents)
805            else:
806                loggy.info("cdk.install_cdk_requirements(): Detected unknown cdk version. You might need to modify cdk.py in gocd library to support this.")
807
808            with open('setup.py', 'w') as file:
809                file.write(_file_contents)
810
811            # subprocess.run(['sed', '-i', '-E', '\'s|aws_cdk.aws_(.*)"|aws_cdk.aws_\1=='+_cdk_required_version+'"|g\'', 'setup.py'], check=True)
812            # sed -i -E 's|aws_cdk.aws_(.*)"|aws_cdk.aws_\1=='$_CDK_REQUIRED_VERSION'"|g' setup.py
813
814            loggy.info("cdk.install_cdk_requirements(): Modified setup.py file.")
815            _new_file_contents = Path('setup.py').read_text()
816            loggy.info(_new_file_contents)
817
818            subprocess.run(['pip3', 'install', '-r', 'requirements.txt'], check=True)
819        else:
820            loggy.info("cdk.install_cdk_requirements(): Error. setup.py does not exist.")
821    elif cdk_lang == 'ts' or cdk_lang == 'typescript':
822        loggy.info("cdk.install_cdk_requirements(): Installing npm requirements.")
823        subprocess.run(['npm', 'install'], check=True)
824    else:
825        loggy.info(f"cdk_lang ({cdk_lang}) unsupported.")
826        return False
827
828    loggy.info("cdk.install_cdk_requirements(): END")
829    return True