github.com/upcmd/up@v0.8.1-0.20230108151705-ad8b797bf04f/tests/functests/c0100.yml

doc_meta: |
  folder: object-oriented
  title: query
  head: |
    query cmd is powerful. It provides a generic way to query either from global runtime vars or a content of yml to register the result to a new var name

  sections:
    - title: query yml content
      content: |
        * ymlkey: use this to point to a var containing the content of yml

        * path: this is a yq like path to use to query/select the node/sub elements/wildcard matched reslt

        * reg: this is the var name to register the queried value


    - title: query var object in global runtime scope
      content: |
        * ymlkey: not required at all

        * path: this is a path to address an object then follow by dot . assignment for sub element


    - title: flags
      content: |
        * localOnly: register the result to local func scope but not global runtime scope

        * collect: register the result to be an yml array/list of values

    - title: query using wildcard
      content: |
        you can use wildcard format to match your selection criteria

        * datapath:
          format is like a.b.c(name=fr*).value, following the yq path format:

          1. 'a.b.c'
          2. 'a.*.c'
          3. 'a.**.c'
          4. 'a.(child.subchild==co*).c'
          5. 'a.array[0].blah'
          6. 'a.array[*].blah'

    - title: Demo
      log: yes

  related:
    refs:
      - title: yq and yq path reference
        link: https://github.com/mikefarah/yq

notes:
  goal:
    - add query demo
    - ymlkey to ref to a var name pointing to a yml string
    - path is the path refer to yml element, ref to the usage example
    - reg is the varname register to
    - |
      localOnly indicate it is registered to local func var scope only
      otherwise it will be in global scope
    - collect is to indicate whether result will be put into array using yml format
    - ymlOnly will register a query result in yml string instead

vars:
  query_name: jason
  student:
    name: Tom
    gender: Male
    school: Sydney Grammar
  nsw:
    sydney:
      - sg:
          student:
            name: Grace
            gender: Female
            school: MLC
      - kings:
          student:
            name: Emily
            gender: Female
            school: KINGS
    chatswood:
      - chatswood_high:
          student:
            name: Jason
            gender: Mail
            school: Public High School

tasks:
  -
    name: task
    task:
      -
        func: cmd
        vars:
          ymlstr: |
            student:
              name: jason
              gender: Male
              school: The Kings
        do:
          - name: query
            desc: query using ref var ymlstr and query a registered var by default in global
            cmd:
              ymlkey: ymlstr
              path: student.school
              reg: school_name

      -
        func: cmd
        do:
          - name: print
            cmd: '{{.school_name}}'

#--------------------------------------------------------------------

      -
        func: cmd
        vars:
          ymlstr: |
            student: |
              name: jason
              gender: Male
              school: The Kings
        do:
          - name: query
            desc: query using ref var ymlstr and query a registered var by default in global
            cmd:
              ymlkey: ymlstr
              path: student
              reg: student_info

      -
        func: cmd
        do:
          - name: print
            cmd: '{{.student_info}}'

#--------------------------------------------------------------------
      -
        func: cmd
        vars:
          ymlstr: |
            student:
              name: jason
              gender: Male
              school: The Kings
        do:
          - name: query
            desc: query and query a registered var in local
            cmd:
              ymlkey: ymlstr
              path: student.school
              reg: local_school_name
            flags: [localOnly]
      -
        func: cmd
        do:
          - name: print
            cmd: '{{.local_school_name}}'
#--------------------------------------------------------------------

      -
        func: cmd
        do:
          - name: query
            desc: query from cached vars only
            cmd:
              path: nsw.sydney.sg.student.school
              reg: data_school_name
      -
        func: cmd
        do:
          - name: print
            cmd: '{{.data_school_name}}'
#--------------------------------------------------------------------
      -
        func: cmd
        do:
          - name: query
            desc: query from cached vars and put result into a list/array
            cmd:
              path: nsw.sydney.**.student.school
              reg: school_name_list
            flags: [collect]
          - name: printObj
            cmd: '{{.school_name_list}}'
          - name: print
            cmd: '{{.school_name_list}}'
#--------------------------------------------------------------------
      -
        func: cmd
        do:
          - name: query
            desc: query a sub node
            cmd:
              path: nsw.sydney
              reg: city
            flags: [collect]
          - name: printObj
            cmd: '{{.city}}'
          - name: print
            cmd: '{{.city}}'
#--------------------------------------------------------------------
      -
        func: cmd
        do:
          - name: query
            desc: query a selected indexed node from a array
            cmd:
              path: nsw.sydney.[1]
              reg: city1
          - name: printObj
            cmd: '{{.city1}}'
          - name: print
            cmd: '{{.city1}}'
#--------------------------------------------------------------------

      -
        func: cmd
        do:
          - name: query
            desc: query all nodes from an array
            cmd:
              path: nsw.sydney.[*]
              reg: cityall
          - name: printObj
            cmd: '{{.cityall}}'
          - name: print
            cmd: '{{.cityall}}'
#--------------------------------------------------------------------
#TO TEST
      -
        func: cmd
        do:
          - name: query
            desc: query result matching the criteria
            cmd:
              path: nsw.sydney.[*].*(name==Emily)
              reg: studentx
          - name: printObj
            cmd: '{{.studentx}}'
          - name: print
            cmd: '{{.studentx}}'

      -
        func: cmd
        do:
          - name: query
            desc: query result matching the criteria
            cmd:
              path: nsw.sydney.[1].*(name==Emily)
              reg: studenty
          - name: printObj
            cmd: '{{.studenty}}'

      -
        func: cmd
        do:
          - name: query
            desc: query result matching the criteria
            cmd:
              path: nsw.sydney.**(name==Emily)
              reg: studentz
          - name: printObj
            cmd: '{{.studentz}}'

      -
        func: cmd
        do:
          - name: query
            desc: query result matching the criteria
            cmd:
              path: nsw.sydney.[*].kings(name==Emily)
              reg: studentm
          - name: printObj
            cmd: '{{.studentm}}'

      -
        func: cmd
        do:
          - name: query
            desc: query result matching the criteria
            cmd:
              path: nsw.sydney.[*].*(name==Grace)
              reg: studentn
          - name: printObj
            cmd: '{{.studentn}}'

      -
        func: cmd
        do:
          - name: query
            desc: query result matching the criteria
            cmd:
              path: nsw.chatswood.[*]
              reg: studento
          - name: printObj
            cmd: '{{.studento}}'

#--------------------------------------------------------------------
      -
        func: cmd
        do:
          - name: query
            desc: query and register result as a yml string instead of object
            cmd:
              path: nsw.
              reg: city2
            flags: [ymlOnly]

          - name: trace
            cmd: ====>
          - name: printObj
            cmd: '{{.city2}}'
          - name: print
            cmd: '{{.city2}}'
          - name: print
            cmd: '{{.city2|len}}'
          - name: trace
            cmd: <====
#--------------------------------------------------------------------
      -
        func: cmd
        do:
          - name: query
            desc: query result from yml file using refdir
            cmd:
              ymlfile: d0100.yml
              refdir: ./tests/functests
              path: nsw.
              reg: city2
            flags: [ymlOnly]

          - name: print
            cmd: '{{.city2}}'

#--------------------------------------------------------------------
      -
        func: cmd
        do:
          - name: query
            desc: query result from yml file using implicit global refdir
            cmd:
              ymlfile: d0100.yml
              path: nsw.
              reg: city2
            flags: [ymlOnly]


          - name: print
            cmd: '{{.city2}}'