Merge ~ziyiwang/juju-lint:lp1851485 into juju-lint:master

[Celia Wang]

    Add bindings check
    1). only check principal charms
    2). if bindings are not explicitly set (which means the bindings are
        default value "alpha"), print warning message
    LP: #1851485

[Celia Wang (ziyiwang)]

Test result:

(juju-lint-test) ziyiwang@selkie:~$ juju-lint -t openstack ../telefonica-func-211202.yaml -c contrib/includes/bindings.yaml
2021-12-03 08:47:24 [INFO] juju-lint version 1.0.2.dev57+gbded6f9.d20211204 starting...
 * Config directory: /home/ziyiwang/.config/juju-lint
 * Rules file: contrib/includes/bindings.yaml
 * Log level: info

2021-12-03 08:47:24 [INFO] [../telefonica-func-211202.yaml] Linting manual file...
2021-12-03 08:47:25 [WARNING] [../telefonica-func-211202.yaml] [manual/manual] Binding for application ubuntu-controllers-stub has not been set.

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[James Troup (elmo)]

As discussed; please retry this without coding the list of principle vs subordinate into the YAML - we should be able to determine that from the Juju data in status/bundle. Thanks.

review: Needs Fixing

Unmerged commits

a692176... by Celia Wang on 2021-12-04

Add bindings check
1). only check principal charms
2). if bindings are not explicitly set (which means the bindings are
    default value "alpha"), print warning message
LP: #1851485

diff --git a/contrib/includes/bindings.yaml b/contrib/includes/bindings.yaml
new file mode 100644
index 0000000..85905c3
--- /dev/null
+++ b/contrib/includes/bindings.yaml
@@ -0,0 +1,137 @@
+openstack mandatory: &openstack-mandatory-charms
+ - ceilometer
+ - ceph-mon
+ - ceph-osd
+ - cinder
+ - glance
+ - heat
+ - keystone
+ - neutron-api
+ - nova-cloud-controller
+ - nova-compute
+ - openstack-dashboard
+
+openstack mandatory deps: &openstack-mandatory-deps
+ - haproxy
+ - memcached
+ - percona-cluster
+ - rabbitmq-server
+
+openstack optional charms: &openstack-optional-charms
+ - aodh
+ - barbican
+ - barbican-vault
+ - ceph-fs
+ - ceph-radosgw
+ - cinder-backup
+ - designate
+ - designate-bind
+ - easyrsa
+ - etcd
+ - glance-simplestreams-sync
+ - glance-sync-slave
+ - gnocchi
+ - ironic-api
+ - ironic-conductor
+ - manila
+ - manila-ganesha
+ - manila-dashboard
+ - mongodb  # Optional since Gnocchi
+ - neutron-gateway
+ - neutron-api-plugin-ironic
+ - octavia
+ - octavia-dashboard
+ - octavia-diskimage-retrofit
+ - placement
+ - swift-proxy
+ - swift-storage
+ - vault
+
+cisco-aci-charms: &cisco-aci-charms
+ - neutron-api-plugin-aci
+ - openstack-dashboard-plugin-gbp
+
+ovn-charms: &ovn-charms
+ - ovn-central
+ - ovn-chassis
+ - neutron-api-plugin-ovn
+
+masakari-charms: &masakari-charms
+ - masakari
+ - masakari-monitors
+ - pacemaker-remote
+
+trilio-charms: &trilio-charms
+ - trilio-dm-api
+ - trilio-horizon-plugin
+ - trilio-data-mover
+ - trilio-wlm
+
+operations mandatory: &operations-mandatory-charms
+ - elasticsearch
+ - grafana
+ - graylog
+ - landscape-server
+ - nagios
+ - prometheus2
+
+operations optional: &operations-optional-charms
+ - infra-node
+ - cloudstats
+ - juju-lint
+
+operations openstack mandatory: &operations-openstack-mandatory-charms
+ - openstack-service-checks
+ - prometheus-openstack-exporter
+
+operations kubernetes mandatory: &operations-kubernetes-mandatory-charms
+ - kubernetes-service-checks
+
+operations mandatory dependencies: &operations-mandatory-deps
+ - postgresql
+
+kubernetes mandatory: &kubernetes-mandatory-charms
+ - containerd
+ - kubeapi-load-balancer
+ - kubernetes-master
+ - kubernetes-worker
+
+kubernetes optional charms: &kubernetes-optional-charms
+ - calico
+ - canal
+ - coredns
+ - easyrsa
+ - etcd
+ - flannel
+ - kubernetes-dashboard
+ - openstack-integrator
+ - vsphere-integrator
+
+operations principal charms: &operations-principal-charms
+ - *operations-kubernetes-mandatory-charms
+ - *operations-mandatory-charms
+ - *operations-mandatory-deps
+ - *operations-optional-charms
+ - *operations-openstack-mandatory-charms
+
+openstack principal charms: &openstack-principal-charms
+ - *openstack-mandatory-charms
+ - *openstack-mandatory-deps
+ - *openstack-optional-charms
+ - *cisco-aci-charms
+ - *ovn-charms
+ - *masakari-charms
+ - *trilio-charms
+
+kubernetes principal charms: &kubernetes-principal-charms
+ - *kubernetes-mandatory-charms
+ - *kubernetes-optional-charms
+
+principal charms: &principal-charms
+ - ubuntu
+ - *openstack-principal-charms
+ - *operations-principal-charms
+ - *kubernetes-principal-charms
+
+endpoints:
+ - *principal-charms
diff --git a/jujulint/lint.py b/jujulint/lint.py
index a59d66a..0b92464 100755
--- a/jujulint/lint.py
+++ b/jujulint/lint.py
@@ -420,6 +420,48 @@ class Linter:
                         lint_rules,
                     )
 
+    def check_binding(self, app_name, binding, rule):
+        """Check application against provided rule."""
+        for check_op, check_value in rule.items():
+            if check_op == "neq":
+                for endpoint_name, endpoint_value in binding.items():
+                    if check_value == endpoint_value:
+                        self._log_with_header(
+                            "Binding {} for application {} has not been set.".format(
+                                endpoint_name,
+                                app_name,
+                            ),
+                            level=logging.WARN,
+                        )
+            else:
+                self._log_with_header(
+                    "Application {} has unknown check operation for {}: {}.".format(
+                        app_name,
+                        rule,
+                        check_op,
+                    ),
+                    level=logging.WARN,
+                )
+
+    def check_bindings(self, applications):
+        """Check application bindings in the model."""
+        for application in applications.keys():
+            # look for config rules for this application
+            lint_rules = []
+
+            charm_name = utils.extract_charm_name(applications[application]["charm"])
+            if "endpoints" in self.lint_rules:
+                if charm_name in self.lint_rules["endpoints"]:
+                    lint_rules = dict([("neq", "alpha")])
+
+            if lint_rules:
+                if "bindings" in applications[application]:
+                    self.check_binding(
+                        application,
+                        applications[application]["bindings"],
+                        lint_rules,
+                    )
+
     def check_subs(self, machines_data):
         """Check the subordinates in the model."""
         all_or_nothing = set()
@@ -1021,6 +1063,9 @@ class Linter:
             # Check configuration
             self.check_configuration(parsed_yaml[applications])
 
+            # Check bindings
+            self.check_bindings(parsed_yaml[applications])
+
             # Then map out subordinates to applications
             for app in parsed_yaml[applications]:
                 self.process_subordinates(parsed_yaml[applications][app], app)