[unit tests] Continuous update

pcoello25 commented 8 years ago

List of test coverage per component/class:

FUNCTIONAL TESTS

OrionSink:

[x] The sink starts properly.
[x] Not mandatory parameters get the default value on configure().
[x] The configuration becomes invalid upon out-of-the-limits configured values for parameters having a discrete set of accepted values, or numerical values having upper or lower limits.
[ ] Not persisted batches are retried.

OrionHDFSSink:

[ ] Not mandatory parameters get the default value on configure().
[ ] The configuration becomes invalid upon out-of-the-limits configured values for parameters having a discrete set of accepted values, or numerical values having upper or lower limits.
[ ] When enable_lowercase=false (default value), the sink is case sensitive when building the persistence element names.
[ ] When enable_lowercase=true, the sink do lowercase on the persistence element names.
[ ] When / service-path is notified/defaulted and data_model=dm-by-entity, the HDFS path name is <service>/<entityId>_<entityType>/<entityId>_<entityType>.txt.
[ ] A HDFS backend has been created.

OrionMySQLSink:

[ ] Not mandatory parameters get the default value on configure().
[ ] The configuration becomes invalid upon out-of-the-limits configured values for parameters having a discrete set of accepted values, or numerical values having upper or lower limits.
[ ] When enable_lowercase=false (default value), the sink is case sensitive when building the persistence element names.
[ ] When enable_lowercase=true, the sink do lowercase on the persistence element names.
[ ] When / service-path is notified/defaulted and data_model=dm-by-entity, the MySQL table name is <entityId>_<entityType>.
[ ] When / service-path is notified/defaulted and data_model=dm-by-service-path, the MySQL table name building must throw an exception.
[ ] A set of notification having the same attributes, but notified in different order, produce inserts of values aligned with the insertion fields.
[ ] A MySQL backend has been created.

OrionCKANSink:

[ ] Not mandatory parameters get the default value on configure().
[ ] The configuration becomes invalid upon out-of-the-limits configured values for parameters having a discrete set of accepted values, or numerical values having upper or lower limits.
[ ] When enable_lowercase=false (default value), the sink is case sensitive when building the persistence element names.
[ ] When enable_lowercase=true, the sink do lowercase on the persistence element names.
[ ] When / service-path is notified/defaulted and data_model=dm-by-entity, the CKAN package name is <service>.
[ ] A CKAN backend has been created.

OrionKafkaSink:

[ ] Not mandatory parameters get the default value on configure().
[ ] The configuration becomes invalid upon out-of-the-limits configured values for parameters having a discrete set of accepted values, or numerical values having upper or lower limits.
[ ] When enable_lowercase=false (default value), the sink is case sensitive when building the persistence element names.
[ ] When enable_lowercase=true, the sink do lowercase on the persistence element names.
[x] When a non root service-path is notified/defaulted and data_model=dm-by-service, the Kafka topic name is <service>.
[x] When a non root service-path is notified/defaulted and data_model=dm-by-service-path, the Kafka topic name is <service>_<service-path>.
[x] When a non root service-path is notified/defaulted and data_model=dm-by-entity, the Kafka topic name is <service>_<service-path>_<entityId>_<entityType>.
[x] When a non root service-path is notified/defaulted and data_model=dm-by-attribute, the Kafka topic name is <service>_<service-path>_<entityId>_<entityType>_<attrName>_<attrType>.
[x] When the root service-path is notified/defaulted and data_model=dm-by-service, the Kafka topic name is <service>.
[x] When the root service-path is notified/defaulted and data_model=dm-by-service-path, the Kafka topic name is <service>.
[x] When the root service-path is notified/defaulted and data_model=dm-by-entity, the Kafka topic name is <service>_<entityId>_<entityType>.
[x] When the root service-path is notified/defaulted and data_model=dm-by-attribute, the Kafka topic name is <service>_<entityId>_<entityType>_<attrName>_<attrType>.
[ ] A Kafka backend has been created.

OrionMongoBaseSink:

[ ] Not mandatory parameters get the default value on configure().
[x] Configured collection_prefix cannot be system..
[x] Configured 'collection_prefix' is encoded when having forbiden characters.
[x] Configured 'db_prefix' is encoded when having forbiden characters.
[x] When / service-path is notified/defaulted and data_model=dm-by-service-path, the MongoDB collection name is <prefix>/.
[x] When / service-path is notified/defaulted and data_model=dm-by-entity, the MongoDB collections name is <prefix>/_<entityId>_<entityType>.
[x] When / service-path is notified/defaulted and data_model=dm-by-attribute, the MongoDB collections name is <prefix>/_<entityId>_<entityType>_<attrName>_<attrType>.

OrionMongoSink:

[ ] Not mandatory parameters get the default value on configure().
[ ] The configuration becomes invalid upon #out-of-the-limits configured values for parameters having a discrete set of accepted values, or numerical values having upper or lower limits.
[ ] When enable_lowercase=false (default value), the sink is case sensitive when building the persistence element names.
[ ] When enable_lowercase=true, the sink do lowercase on the persistence element names.
[ ] When TimeInstant is present as a metadata, this value is used instead of the reception time.
[ ] Notified subservice must start with /.
[ ] Configured default_service_path must start with /.
[ ] A MongoDB backend has been created.

OrionSTHSink:

[x] Not mandatory parameters get the default value on configure().
[x] Non valid resolutions are detected.
[x] Empty 'resolutions' means no persistence for any resolution.
[ ] The configuration becomes invalid upon out-of-the-limits configured values for parameters having a discrete set of accepted values, or numerical values having upper or lower limits.
[ ] When enable_lowercase=false (default value), the sink is case sensitive when building the persistence element names.
[ ] When enable_lowercase=true, the sink do lowercase on the persistence element names.
[ ] When TimeInstant is present as a metadata, this value is used instead of the reception time.
[ ] Notified subservice must start with /.
[ ] Configured default_service_path must start with /.
[ ] A MongoDB backend has been created.

OrionDynamoDBSink:

[ ] Not mandatory parameters get the default value on configure().
[ ] The configuration becomes invalid upon out-of-the-limits configured values for parameters having a discrete set of accepted values, or numerical values having upper or lower limits.
[ ] When enable_lowercase=false (default value), the sink is case sensitive when building the persistence element names.
[ ] When enable_lowercase=true, the sink do lowercase on the persistence element names.
[ ] A DynamoDB backend has been created.

OrionPostgreSQLSink:

[ ] Not mandatory parameters get the default value on configure().
[ ] The configuration becomes invalid upon out-of-the-limits configured values for parameters having a discrete set of accepted values, or numerical values having upper or lower limits.
[ ] When enable_lowercase=false (default value), the sink is case sensitive when building the persistence element names.
[ ] When enable_lowercase=true, the sink do lowercase on the persistence element names.
[ ] A PostgreSQL backend has been created.

OrionCartoDBSink:

[ ] Not mandatory parameters get the default value.
[x] Configured flip_coordinates cannot be different than true or false.
[x] Configured enable_raw cannot be different than true or false.
[x] Configured enable_distance cannot be different than true or false.
[x] Configured data_model cannot be different than dm-by-service-path or dm-by-entity.
[x] Configured keys_conf_file cannot be empty.
[x] Independently of the configured value, enable_lowercase=true always.
[x] Username field must appear within an entry in the keys file.
[x] Username within an entry in the keys file cannot be empty.
[x] Endpoint field must appear within an entry in the keys file.
[x] Endpoint within an entry in the keys file cannot be empty.
[x] Endpoint within an entry in the keys file must be a URI using the http or https schema.
[x] Key field must appear within an entry in the keys file.
[x] Key within an entry in the keys file cannot be empty.
[x] When started, a CartoDB backend is created from a valid keys file.
[x] The schema name is equals to the notified/defaulted service.
[x] When a non root service-path is notified/defaulted and data_model=dm-by-service-path, the CartoDB table name is <servicePath>.
[x] When a non root service-path is notified/defaulted and data_model=dm-by-entity, the CartoDB table name is <servicePath>_<entityId>_<entityType>.
[x] When the root service-path is notified/defaulted and data_model=dm-by-service-path, the CartoDB table name cannot be created.
[x] When the root service-path is notified/defaulted and data_model=dm-by-entity, the CartoDB table name is <entityId>_<entityType>.

OrionCartoDBSink.CartoDBAggregator:

[x] When initializing through an initial geolocated event, a table name is created.
[x] When initializing through an initial geolocated event, the aggregation fields string contains a field and a metadata field for each attribute in the event except for the geolocation attribute, which is added as a specific field (the_geom).
[x] When initializing through an initial geolocated event, the aggregation fields string is lower case, starts with ( and finishes with ).
[x] When aggregating a single geolocated event, the aggregation values string contains a value and a metadata value for each attribute in the event except for the geolocation attribute, which is added as a specific value (a point).
[x] When aggregating a single geolocated event, the aggregation values string starts with ( and finishes with ).
[x] When aggregating a single geolocated event, if flip_coordinates=true then the_geom field contains a point with exchanged latitude and longitude.
[ ] When aggregating two or more geolocated events, each event data is contained in the aggregation values string, separated by comma.
[ ] When aggregating two or more geolocated events, each event data field is aligned with the rest of events data fields.

OrionTestSink:

[ ] When enable_lowercase=false (default value), the sink is case sensitive when building the persistence element names.
[ ] When enable_lowercase=true, the sink do lowercase on the persistence element names.

KafkaBackend:

[x] The backend sends a message to Kafka.
[ ] The backend creates a new topic in Kafka.
[ ] The backend tells if a topic already exists in Kafka.

OrionRestHandler:

[x] Not mandatory parameters get the default value on configure().
[x] The configured default service can only contain alphanumerics and underscores.
[x] he configured default service path can only contain alphanumerics and underscores.
[x] The configured default_service_path must start with /.
[x] The configured notification_target must start with /.
[x] When a notification is sent, the Content-Type header is application/json; charset=utf-8.
[x] When a notification is sent and the fiware-service header is present, its length must not exceed the limits.
[x] When a notification is sent and the fiware-servicePath header is present, its length must not exceed the limits.
[x] When a notification is sent and the fiware-servicePath header is present, it must start with /.
[x] When the configuration is invalid, no events are processed.
[x] When a notification is sent as a Http message, a single Flume event is generated.
[x] When a Flume event is generated, it contains fiware-service, fiware-servicepath, fiware-correlator and transaction-id headers.
[x] When a Flume event is generated, it contains the payload of the Http notification as body.
[x] An internal transaction ID is generated.
[x] When a correlator ID is notified, it is reused.
[x] When a correlation ID is not notified, it is generated.
[x] When a correlation ID is generated, both generated correlation ID and generated transaction ID have the same value.

Management Interface:

[ ] GET /v1/stats gets a valid Json response.
[ ] PUT /v1/stats sets to 0 the Flume element counters.
[ ] PUT /admin/log?level=<valid_log_level> sets the logging level to ,
[ ] PUT /admin/log?level=<invalid_log_level> returns 400 Bad Request.
[ ] POST /v1/subscriptions?ngsi_version=<ngsi_version> post a valid subscription
[ ] DELETE /v1/subscriptions?ngsi_version=<ngsi_version>&subscription_id=<subscription_id> deletes a subscription
[ ] GET /v1/subscriptions?ngsi_version=<ngsi_version>&subscription_id=<subscription_id> gets a valid Json response.
[ ] GET /v1/subscriptions?ngsi_version=<ngsi_version> gets a valid Json response.
[x] GET /admin/configuration/agent/path/to/agent.conf gets a valid Json response
[x] GET /admin/configuration/agent/path/to/agent.conf?param=<param_name> gets a valid Json response
[x] POST /admin/configuration/agent/path/to/agent.conf?param=<param_name>&value=<param_value> post succesfully a parameter in the agent
[x] PUT /admin/configuration/agent/path/to/agent.conf?param=<param_name>&value=<param_value> update succesfully a parameter in the agent
[x] DELETE /admin/configuration/agent/path/to/agent.conf?param=<param_name> deletes succesfully a parameter in the agent
[x] When check the agent name, must start with agent_
[x] GET /admin/configuration/instance/path/to/instance.conf gets a valid Json response
[x] GET /admin/configuration/instance/path/to/instance.conf?param=<param_name> gets a valid Json response
[x] POST /admin/configuration/instance/path/to/instance.conf?param=<param_name>&value=<param_value> post succesfully a parameter in the instance
[x] PUT /admin/configuration/instance/path/to/instance.conf?param=<param_name>&value=<param_value> update succesfully a parameter in the instance
[x] DELETE /admin/configuration/instance/path/to/instance.conf?param=<param_name> deletes succesfully a parameter in the instance

CygnusGroupingRule:

[x] The service-paths within grouping rules start with /.
[x] Rule’s pattern is not null.
[x] Rule’s id is upper than 0.
[x] Rule’s fields are not null.
[x] Rule’s regex is not null.
[x] Rule’s destination is not null.
[x] Rule’s newFiwareServicePath is not null.

CygnusGropuingRules:

[x] Unexistent/unreadable grouping rules file is detected.
[x] Syntax errors in the grouping rules are detected.
[x] Missing or empty fields in all the grouping rules are detected.
[x] Service path based matching rules match.
[x] Service path and entity ID based matching rules match.
[x] Service path, entity ID and entity type based matching rules match.
[x] Adding a new rule works.
[x] When a rule is added, the index increases by 1.
[x] Deleting an existent rule works.
[x] Updating an existent rule works.

NGSIGroupingInterceptor:

[x] Not mandatory parameters get the default value on configure().
[x] When configured, enable_new_encoding must be true or false.
[x] Configured grouping_rules_conf_file cannot be empty.
[x] Configured grouping_rules_conf_file cannot be null.

NGSICharsets:

[x] CartoDB: Upper case not accented characters are encoded.
[x] CartoDB: Lower case not accented characters are not encoded.
[x] CartoDB: Numbers are not encoded.
[x] CartoDB: Underscore is not encoded.
[x] CartoDB: '=' (internal concatenator) is encoded as "x0000" (public concatenator).
[x] CartoDB: Non lower case alphanumerics and undersocre are encoded.
[x] CartoDB: A single 'x' is not encoded.
[x] CartoDB: "x0000" is encoded (escaped) as "xx0000".

NON FUNCTIONAL TESTS

HttpBackend:

[ ] Http response payload splited by \n are correctly processed.

Utils:

[x] When getting a time instant, it is properly obtained when passing a valid ISO 8601 timestamp without miliseconds.
[x] When getting a time instant, it is properly obtained when passing a valid ISO 8601 timestamp with miliseconds.
[x] When getting a time instant, it is properly obtained when passing a valid ISO 8601 timestamp with microseconds.
[x] When getting a time instant, it is properly obtained when passing a valid SQL timestamp without miliseconds.
[x] When getting a time instant, it is properly obtained when passing a valid SQL timestamp with miliseconds.
[x] When getting a time instant, it is properly obtained when passing a valid SQL timestamp with microseconds.
[x] When getting a location, a CartoDB point is obtained when passing an attribute of type geo:point.
[x] When getting a location, a CartoDB point is obtained when passing an attribute with a WGS85 location metadata.
[x] When getting a location, the original attribute is returned when the attribute type is not geo:point and there is no WGS84 location metadata.

Effort: 7 man day

pcoello25 commented 8 years ago

Now OrionMongoSinkTest and OrionSTHSinktest don't make their tests. Fixing https://github.com/telefonicaid/fiware-cygnus/issues/609 I notice both was calling an obsolete method and I've had to delete it.

frbattid commented 8 years ago

I would suggest to start editing the first message for adding all the tests coverage we would like to do.

frbattid commented 8 years ago

Adding an initial list of Unit Tests to be implemented (or reimplemented) and a checkbox that can be marked when the test implementation is done:

[x] Done
[ ] Not done

No milestone, no assignee. This wil be an open issue until all the checkboxes are marked.

frbattid commented 8 years ago

Please, follow this format for the tests:

    /**
     * [OrionMongoBaseSink] -------- Configured 'collection_prefix' cannot be 'system.'.
     */
    @Test
    public void testConfiguredCollectionPrefixIsNotSystem() {
        System.out.println("[OrionMongoBaseSink] -------- Configured 'collection_prefix' cannot be 'system.'");
        String collectionPrefix = "system.";
        sink.configure(createContext(collectionPrefix));

        try {
            assertTrue(sink.invalidConfiguration);
            System.out.println("[OrionMongoBaseSink] -  OK  - 'system.' value detected for 'collection_prefix'");
        } catch (AssertionError e) {
            System.out.println("[OrionMongoBaseSink] - FAIL - 'system.' value not detected for 'collection_prefix'");
            throw e;
        } // try catch
    } // testConfiguredCollectionPrefixIsNotSystem

telefonicaid / fiware-cygnus

[unit tests] Continuous update #754