zendframework / zend-diagnostics

Universal set of diagnostic tests for PHP applications.

Welcome to the Zend Framework 3.0 Release!

RELEASE INFORMATION

Zend Framework 3.0.1dev

This is the first maintenance release for the Zend Framework 3 series.

DD MMM YYYY

UPDATES IN 3.0.1

Please see CHANGELOG.md.

SYSTEM REQUIREMENTS

Zend Framework 3 requires PHP 5.6 or later; we recommend using the latest PHP version whenever possible.

INSTALLATION

We no longer recommend installing this package directly. The package is a metapackage that aggregates all components (and/or integrations) originally shipped with Zend Framework; in most cases, you will want a subset, and these may be installed separately; see https://docs.zendframework.com/ for a list of available packages and installation instructions for each.

We recommend using either the zend-mvc skeleton application:

$ composer create-project zendframework/skeleton-application project

or the Expressive skeleton application:

$ composer create-project zendframework/zend-expressive-skeleton project

The primary use case for installing the entire framework is when upgrading from a version 2 release.

If you decide you still want to install the entire framework:

$ composer require zendframework/zendframework

GETTING STARTED

A great place to get up-to-speed quickly is the Zend Framework QuickStart.

The QuickStart covers some of the most commonly used components of ZF. Since Zend Framework is designed with a use-at-will architecture and components are loosely coupled, you can select and use only those components that are needed for your project.

MIGRATION

For detailed information on migration from v2 to v3, please read our Migration Guide.

COMPONENTS

This package is a metapackage aggregating the following components:

• zend-authentication
• zend-barcode
• zend-cache
• zend-captcha
• zend-code
• zend-config
• zend-console
• zend-crypt
• zend-db
• zend-debug
• zend-di
• zend-diactoros
• zend-dom
• zend-escaper
• zend-eventmanager
• zend-feed
• zend-file
• zend-filter
• zend-form
• zend-http
• zend-hydrator
• zend-i18n
• zend-i18n-resources
• zend-inputfilter
• zend-json
• zend-json-server
• zend-loader
• zend-log
• zend-mail
• zend-math
• zend-memory
• zend-mime
• zend-modulemanager
• zend-mvc
• zend-mvc-console
• zend-mvc-form
• zend-mvc-i18n
• zend-mvc-plugins
• zend-navigation
• zend-paginator
• zend-permissions-acl
• zend-permissions-rbac
• zend-progressbar
• zend-psr7bridge
• zend-serializer
• zend-server
• zend-servicemanager
• zend-servicemanager-di
• zend-session
• zend-soap
• zend-stdlib
• zend-stratigility
• zend-tag
• zend-test
• zend-text
• zend-uri
• zend-validator
• zend-view
• zend-xml2json
• zend-xmlrpc
• zendxml

CONTRIBUTING

If you wish to contribute to Zend Framework, please read the CONTRIBUTING.md and CODE_OF_CONDUCT.md files.

QUESTIONS AND FEEDBACK

Online documentation can be found at https://docs.zendframework.com/. Questions that are not addressed in the manual should be directed to the relevant repository, as linked above.

If you find code in this release behaving in an unexpected manner or contrary to its documented behavior, please create an issue with the relevant repository, as linked above.

Reporting Potential Security Issues

If you have encountered a potential security vulnerability in Zend Framework, please report it to us at [email protected]. We will work with you to verify the vulnerability and patch it.

When reporting issues, please provide the following information:

• Component(s) affected
• A description indicating how to reproduce the issue
• A summary of the security vulnerability and impact

We request that you contact us via the email address above and give the project contributors a chance to resolve the vulnerability and issue a new release prior to any public exposure; this helps protect Zend Framework users and provides them with a chance to upgrade and/or update in order to protect their applications.

For sensitive email communications, please use our PGP key.

LICENSE

The files in this archive are released under the Zend Framework license. You can find a copy of this license in LICENSE.md.

ACKNOWLEDGEMENTS

The Zend Framework team would like to thank all the contributors to the Zend Framework project; our corporate sponsor, Zend Technologies / Rogue Wave Software; and you, the Zend Framework user.

Please visit us sometime soon at http://framework.zend.com.

zend-diagnostics's Issues

UnitTest on travis fails

each PHP version tests fails since 17days ago
https://travis-ci.org/zendframework/ZendDiagnostics/builds

first stable release?

so as liip/LiipMonitorBundle#41 is about to get merged, it would be good to tag a first release. so it would like to know what is the process here? to at least get a development release. but also for getting a stable release ..

/cc @Thinkscape @weierophinney

Please add LICENSE file

Without this file, redistribution of this library in any project will be impossible with violating the BSD license term:

* Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.

Also see: https://fedoraproject.org/wiki/Packaging:LicensingGuidelines#License_Text

ZendDiagnostics\Check\ProcessRunning doesn't work in small cli windows

Hello, the ZendDiagnostics\Check\ProcessRunning::check doesn't work in small cli windows.

A Solution would be to add -ww to the ps command.

exec('ps -efww | grep ' . escapeshellarg($this->processName) . ' | grep -v grep', $output, $return);

ps manual:

-w Wide output. Use this option twice for unlimited width.

Design common interfaces

This is a continuation of discussion from zendframework/ZFTool#39

Create ZendDiagnostics website

I'd like to have a website explaining the benefits and best practices for production apps' diagnostics suite.

It would also include usage examples for various frameworks and a catalog of available checks.

Risky tests

Some tests are being marked as Risky: https://travis-ci.org/zendframework/ZendDiagnostics/jobs/42644540#L111

Running the tests with -v displays the following messages:

There were 4 risky tests:

1) ZendDiagnosticsTest\BasicConsoleReporterTest::testUnknownSymbols
Test code or tested code did not (only) close its own output buffers

2) ZendDiagnosticsTest\BasicConsoleReporterTest::testProgressDotsNoGutter
Test code or tested code did not (only) close its own output buffers

3) ZendDiagnosticsTest\BasicConsoleReporterTest::testProgressOverflow
Test code or tested code did not (only) close its own output buffers

4) ZendDiagnosticsTest\BasicConsoleReporterTest::testProgressOverflowMatch
Test code or tested code did not (only) close its own output buffers

I am not sure how to fix these...

Update LiipMonitorBundle to use ZendDiagnostics

Enable coveralls for the library

It seems that coveralls is not enabled for the library:
https://coveralls.io/github/zendframework/zend-diagnostics?branch=master
but in travis we try upload the coverage and the whole coveralls configuration is present in the library.

Can we please enable it to see the proper coverage badge on the main page, please?

Update ZFTool\Diagnostics to use ZendDiagnostics

zendframework/ZFTool#66

Ideas for ZF2-specific checks

• Check view_manager template_map and template_path_stack
  • Check for existence
  • Check for readability
  • Lint the PHP code
• Check Zend\Db connection availability
• Generic Zend\Cache\Adapter check, optionally probing for capabilities and checking that too.
• Generic Zend\Session\Adapter check.
• Try to instantiate all SM services found in configuration and catch exceptions.
• Is module installed ? (request)

test setup improvements

Is anyone open for improvements to the test setup? E.g. phpunit as require-dev, a Makefile etc.? I'll PR it then.

Use an assertion library for parameter validation in checks

Like https://packagist.org/packages/beberlei/assert or https://packagist.org/packages/peridot-php/leo

I would be happy to provide a PR if you accept such a contribution.

Lost check alias for single checking

Consider using queue interprop as abstraction for queues

Hello!

Please look at https://github.com/queue-interop/queue-interop project. Using interfaces from it allows us reuse some implementations like enqueue, which supports a lot of transports. You can outsource some code

Alias of check is lost for single checking

In this loop $alias always will be 0, if $checkAlias is not null
https://github.com/zendframework/ZendDiagnostics/blob/master/src/ZendDiagnostics/Runner/Runner.php#L112

Problem in this line of code:
https://github.com/zendframework/ZendDiagnostics/blob/master/src/ZendDiagnostics/Runner/Runner.php#L106
For example, this will solve this problem:
$checks = $checkAlias ? new ArrayObject(array($checkAlias => $this->getCheck($checkAlias))) : $this->getChecks();

enable travis-ci

/cc @weierophinney @Thinkscape

New tag with Mongo checker

Add please new tag

php72 error signature?

Declaration of ZendDiagnostics\Result\Collection::offsetSet($index, $checkResult) must be compatible with SplObjectStorage::offsetSet($object, $inf = NULL)

is this a php72 side effect?

liip/LiipMonitorBundle#157

[2017-12-05 17:56:35] request.CRITICAL: Uncaught PHP Exception Symfony\Component\Debug\Exception\FatalErrorException: "Compile Error: Declaration of ZendDiagnostics\Result\Collection::offsetSet($index, $checkResult) must be compatible with SplObjectStorage::offsetSet($object, $inf = NULL)" at /private/var/www/system/var/vendor/zendframework/zenddiagnostics/src/ZendDiagnostics/Result/Collection.php line 219 {"exception":"[object] (Symfony\Component\Debug\Exception\FatalErrorException(code: 0): Compile Error: Declaration of ZendDiagnostics\Result\Collection::offsetSet($index, $checkResult) must be compatible with SplObjectStorage::offsetSet($object, $inf = NULL) at /private/var/www/system/var/vendor/zendframework/zenddiagnostics/src/ZendDiagnostics/Result/Collection.php:219)"} []
[2017-12-05 17:56:35] request.INFO: Matched route "_wdt". {"route":"_wdt","route_parameters":{"_controller":"web_profiler.controller.profiler:toolbarAction","token":"007c14","_route":"_wdt"},"request_uri":"https://system.m/_wdt/007c14","method":"GET"} []

Rename repository to zend-diagnostics (with dash)

Currently the repository name is: zendframework/zenddiagnostics.
Can we rename it to zendframework/zend-diagnostics (with dash) to match naming convention in ZF repo names?

See:

• https://packagist.org/packages/zendframework/zenddiagnostics

zend-diagnostics/composer.json

Line 2 in 94e743e

"name": "zendframework/zenddiagnostics",

HttpService with HTTP Basic authentication

I require checking an service that uses authentication.

Using http://user:[email protected] as the host does not work. Is this something that can be added to the current HttpService?

I have created a Guzzle version of HttpService that works. I can make a PR to add if the current HttpService cannot handle.

There needs to be an exit code for CI purposes

https://github.com/zendframework/ZendDiagnostics/blob/d27aa064c5185c5830e917ffe48284b0995eed13/src/ZendDiagnostics/Runner/Reporter/BasicConsole.php#L254

https://www.perpetual-beta.org/weblog/php-from-the-command-line.html#exit-codes

ServiceLocatorAwareInterface is deprecated

Hi...

I found a error when run diagnostics.

Import checks from ZFTool\Diagnostics to ZendDiagnostics

Import checks from LiipMonitor to ZendDiagnostics

What if I want to send a JSON body on the request?

I'm having an issue because I cannot test a http services that is supposed to receive a json on the body, here is the problem:

https://github.com/zendframework/ZendDiagnostics/blob/d27aa064c5185c5830e917ffe48284b0995eed13/src/ZendDiagnostics/Check/GuzzleHttpService.php#L105

This line will have to say:

array('headers' => $this->headers, 'json' => $this->body, 'exceptions' => false),

Maybe there should be a way to specify the type of body that we want to pass, something like:

$body = ['body' => $this->body];
if($this->body['json']) $body = ['json' => $this->body['json'] ];
array('headers' => $this->headers, $body, 'exceptions' => false),

Add basic Runner

Create ZendDiagnostics\Runner used to run a bundle of Checks and return a collection of results.

Using Diagnostics with Symfony 2

There is a Link in the README announcing the usage of ZendDiagnostics with Symfony 2 with the LiipMonitorBundle. What exactly is missing/WIP to make this final?

Or is it just a readme adjustment to be done?